{ "openapi": "3.2.0", "info": { "title": "Aprimo DAM REST API", "description": "The Aprimo DAM REST API lets you interact with your DAM tenant programmatically.\n\n## Introduction\n\nUsing the API you interact with resources such as:\n\n- Record\n- Classification, RecordClassification\n- Field, FieldDefinition\n- File, FileVersion, FilePreview, AdditionalFile\n- Image, Watermark\n- Language\n- MaintenanceJob\n- etc.\n\nThe API follows hypermedia-driven web API conventions, using HAL (Hypertext Application Language) conventions: related resources are linked under `_links`, and related resources requested for expansion appear inline under `_embedded`. Each resource can be accessed directly through its own URI, or as an embedded sub-resource of its parent (for example, embedded in a collection resource). Some response fields and sub-resources are opt-in and only returned when explicitly requested, typically via a `select-` request header naming the additional fields or relations to include (see Selecting below). Requesting `application/hal+json` returns the full HAL representation with `_links`/`_embedded`; requesting `application/json` returns a plain representation without those HAL wrapper properties.\n\nTo read a resource, a standard HTTP GET request is used. The request can include some optional parameters which allow you to control how much of the information should be included/excluded in the returned resource, depending on how much information is needed.\n\nTo update a resource, a standard HTTP PUT request is used. You only need to specify the resource properties you want changed - see Editing resources below for the full pattern.\n\nTo create a new resource, a standard HTTP POST request is performed on the appropriate collection of such resources. For example, if you would like to create a new record, you would perform an HTTP POST request on a record collection. If you don't specify some of the optional resource properties in your request, the default values will be used.\n\nTo delete a resource, a standard HTTP DELETE request is used. Based on your access rights, you might be denied the request to delete a resource.\n\nIf you want to know more about how to find your way around the API, see Navigating the API below.\n\n## Getting started\n\n### Navigating the API\n\nThe Aprimo DAM REST API supports two different ways of consuming and navigating the API:\n\n#### Base URLs\n\n- **REST API**: `https://{aprimoDomain}.dam.aprimo.com/api/core/`\n- **File uploads**: `https://{aprimoDomain}.aprimo.com/uploads` - a separate service on a different subdomain (no `.dam.` and no `/api/core` prefix); see Uploading files.\n\nReplace `{aprimoDomain}` with your tenant's domain name.\n\n#### HAL/JSON hypermedia\n\nOnce a resource is retrieved, your client can bookmark the URI in its cache. The existing relation names will not change over time, but new relations can be introduced.\n\nLinks in the returned resource representation help you to navigate the API, just by following those links. Using this approach helps create API clients/servers that do not depend too much on each other and can be developed in an independent way, as long as both the client and the server have a common understanding of media types used in the communication. For example, you can start using the API by going to the root URI of the API and discover all the resources you can access. From that point on, you can follow links and explore the resources existing throughout the API. You can use the \"select\" keys, present in most of the resources, which provide you with information about which sub-resources can be embedded in that resource. This way you can retrieve the exact information needed in a single request, which helps you optimize the chattiness of the API for your specific use case.\n\n#### Plain JSON consumption\n\nNext to using the HAL/JSON hypermedia API, clients can also consume the API using plain JSON. HAL is useful while exploring the API or building a client that needs to discover resources at runtime, since it requires no upfront knowledge of the URIs for the endpoints you'll need. Once you know which endpoints your integration uses, requesting `application/json` instead is recommended: it omits the `_links`/`_embedded` wrapper properties, producing a smaller, flatter response that's cheaper to transfer and parse. For pure JSON clients, we provide an exhaustive list of the endpoints available in the API.\n\n### The API-Version header\n\nA required request header specifying which version of the API the request targets:\n\n```http\nAPI-Version: 1\n```\n\nA few endpoints are exempt - kept version-agnostic (always the same result regardless of the header, only ever adding backwards-compatible information) so that consumers can discover the list of supported API versions before committing to one. See Endpoint header requirements below for the complete list of exceptions.\n\n### Media types\n\nThe Aprimo DAM REST API supports the following media types:\n\n**Response media types:**\n\n- `application/hal+json` (default)\n- `application/json`\n\n**Request media types:**\n\n- `application/json` (default)\n\n## Examples\n\nWorked request/response examples for common tasks are attached directly to the relevant endpoints in this specification - open an operation (for example `GET /record/{recordId}` or `POST /record`) to see its example request and response. Scenarios cover records, record locks, files, file versions, file previews, download links, collections, content subscriptions, classifications, content types, field definitions, field groups, orders, maintenance jobs, permissions, rules, setting definitions, and settings.\n\n## Basic concepts\n\n### Selecting\n\nThe selecting feature is used in the Aprimo DAM REST API to support the dynamic nature of the Aprimo DAM resources and to provide the API consumers with a way to select a custom granularity level for the resource representation they want to retrieve from Aprimo DAM. It helps consumers retrieve more information using a single request.\n\nBy default, when a resource is requested, it is usually returned using a minimal representation, which contains as little data as possible (for example, all of the sub-resources of the requested resource are not returned in this minimal representation). If needed, a consumer can extend this resource representation by selecting more data to be included, using the \"select\" header parameter.\n\nThe general format of the select parameter is: `\"Select-{Resource}: SubResource1,SubResource2,SubResource3, ...\"` where the value is a comma-separated list of subresources to be included in the resulting resource representation. It specifies that the returned resource's representation also contain its subresources, beside the basic/minimal data, which is always returned. For example, to request a list of records, with their classifications and files included with each returned record resource, a consumer typically performs a request like this:\n\n```http\nGET /records\naccept: application/hal+json\nselect-record: classifications, files\n```\n\nIt is also possible to further select the sub-resource's additional attributes in the same request. For example, if a consumer likes to select the children for each classification returned with each record, it is done in this way:\n\n```http\nGET /records\naccept: application/hal+json\nselect-record: classifications, files\nselect-classification: children\n```\n\nThe returned records collection resource contains records, each of which has the embedded files collection resource and the classifications collection resource with each classification's children collection embedded in the classification resource. All of this has been accomplished in a single request.\n\nThere is a possible recursion issue in this particular case, since the \"children\" sub-resource is also a collection of classifications, each of which can have \"children\" as a sub-resource, too, which could lead to an unexpected data overflow. To avoid this, a limit was introduced to return only the first level of recursive sub-resources (see Advanced selecting and preventing recursion).\n\n#### Sub-resources\n\nIn case sub-resources are returned as linked resources of another parent resource, all of those sub-resources will have an additional attribute named \"select-key\". This parameter indicates that the sub-resource can be selected (embedded) in the parent resource representation. The value of the \"select-key\" parameter can be used as a value of the \"select-<parent-resource>\" parameter. For example, to get a record:\n\n```http\nGET /record/250d22a231ed4f0ba9afa49900b0252e\naccept: application/hal+json\n```\n\nWe can see there are numerous linked resources available for that record, which can be selected (embedded) in the returned record representation, using the specified \"select-key\" parameter:\n\n```json\n{\n \"_links\": {\n \"self\": {\n \"href\": \"/record/250d22a231ed4f0ba9afa49900b0252e\"\n },\n \"fields\": {\n \"href\": \"/record/250d22a231ed4f0ba9afa49900b0252e/fields\",\n \"select-key\": \"fields\"\n },\n \"files\": {\n \"href\": \"/record/250d22a231ed4f0ba9afa49900b0252e/files\",\n \"select-key\": \"files\"\n }\n },\n \"id\": \"250d22a231ed4f0ba9afa49900b0252e\",\n \"createdOn\": \"2015-05-15T10:41:19.51Z\",\n \"modifiedOn\": \"2015-06-12T11:13:15.433Z\",\n \"tag\": null\n}\n```\n\nTo request a record resource, with, for example, all the fields selected, look at the \"fields\" linked resource for the \"`select-key`\" parameter with the value \"`fields`\". This value means that you can include this sub-resource within the record resource just by specifying \"`select-record: fields`\", when requesting the record next time, like this:\n\n```http\nGET /record/250d22a231ed4f0ba9afa49900b0252e\naccept: application/hal+json\nselect-record: fields\n```\n\nThis time you will get the fields embedded within the record resource instead of just returning a linked resource. This way you can dynamically change the amount of information returned for the same resource requested.\n\nFor a more detailed example, see the record resource's \"Reading a record\" example.\n\n#### Attributes\n\nNext to the sub-resources, some resource attributes can also be selected (included or excluded from the requested resource representation). If not selected, these attributes will NOT be returned by default. This will be clearly indicated in the description of the property on the resource page.\n\nThe listed attributes were either rarely used or the calculation of their value was too expensive to be included in the default representation of a resource, consequently, it was decided to hide these attributes unless a consumer specifically selects them.\n\n#### Explicit fields selection\n\nWhen selecting the fields of a record, classification, user or file, it can be useful to select only certain fields, instead of having them all included in the returned resource. For example, to select fields of a record:\n\n```http\nGET /record/250d22a231ed4f0ba9afa49900b0252e\naccept: application/hal+json\nselect-record: fields\n```\n\nThis selects all the fields on that record. To filter out specific fields (or field groups), you can use additional header parameters that provide such filtering, like \"`select-record-fields`\" and \"`select-record-fieldgroups`\". The value for these parameters is a comma-separated list of fields/fieldgroups. Fields and field groups can be specified using their Ids (in the form of a GUID) or their names. Since the field/fieldgroup names can contain random text, it is advised to properly encode them using [\"Percent-Encoding\"](https://www.rfc-editor.org/rfc/rfc3986#section-2.1) so that they can safely pass over the network to the API server. Also take into account that the \"comma\" character needs to be escaped because it has a special meaning in the HTTP header values. This is an example of the selected fields' filtering feature:\n\n```http\nGET /record/250d22a231ed4f0ba9afa49900b0252e\naccept: application/hal+json\nselect-record: fields\nselect-record-fields: 295B1779-A381-4018-BE1D-B29E3458B41C, MyField, DummyField\nselect-record-fieldgroups: TestFieldGroup, CDE8E0C4-CD7E-47BC-93D3-0F54C7109FB6, FooBarGroup\n```\n\nIn the previous example there was no need to use the percent-encoding, but let's consider an example where escaping is required. The field \"`My,Field,With,Commas`\" contains a \"comma\" character in its name. To escape it properly, because in HTTP the header values represent the list of comma-separated values, and to avoid selecting fields with these names: \"`My`\", \"`Field`\", \"`With`\" and \"`Commas`\", you need to percent-encode the field name so that the request reads as follows:\n\n```http\nGET /record/250d22a231ed4f0ba9afa49900b0252e\naccept: application/hal+json\nselect-record: fields\nselect-record-fields: My%2CField%2CWith%2CCommas\n```\n\nThis request will result in one field only, named \"`My,Field,With,Commas`\".\n\n#### Default values in field selection\n\nYou can choose receive default values in your result set by adding an additional header parameter named **select-resolve-default-values**. The value for this parameter must either contain `true` or `false`. Empty values and spaces will be ignored. True will return default values and false will omit default values. If this parameter is omitted, you will receive default values in your selected fields.\n\n```http\nGET /record/250d22a231ed4f0ba9afa49900b0252e\naccept: application/hal+json\nselect-record: fields\nselect-record-fields: 295B1779-A381-4018-BE1D-B29E3458B41C, MyField, DummyField\nselect-record-fieldgroups: TestFieldGroup, CDE8E0C4-CD7E-47BC-93D3-0F54C7109FB6, FooBarGroup\nselect-resolve-default-values: false\n```\n\n#### Advanced selecting and preventing recursion\n\nThe REST API will intelligently decide on whether or not to select a resource. Selecting is done based on the resource type. However, the number of times a resource is selected, is limited to prevent recursion. Without that limitation, querying for instance a user with `\"Select-User: CreatedBy\"` can lead to a recursive embedding loop where the selection is endlessly re-applied to the embedded resource.\n\nTo remedy this, the API will perform selections in such a way that any resource type cannot occur more than two times in the path leading from the topmost resource to the leaves. For instance:\n\n```http\nGET /user/{id}\nselect-user: createdby\n```\n\nwill return the `user`, and embed the `createdby`. The `select-user: createdby` will no longer be applied to the embedded `createdby` user, even though this too is a user resource. Similarly:\n\n```http\nGET /classification/{id}\nselect-classification: parent, children\n```\n\nwill return the specified classification, and embed its parents and children. However, the children of the parent and the parent of the children will not be embedded. This also applies to deeper levels of nesting:\n\n```http\nGET /user/{id}\nselect-user: fields\nselect-field: definition\nselect-fielddefinition: createdby\n```\n\nwill return the following 'tree' of embedded resources:\n\n```\nuser\n .field\n .definition\n .createdby\n .field\n .definition\n .createdby\n```\n\nAfter the second occurrence of the `createdby` the embedding will stop, because the API will detect that `createdby` is of type user, which also appears higher up in the embedding tree.\n\n#### Embedding/following relations that result in missing data\n\nWhen a relation points to either of the following:\n\n- an image with `HasImage=false`\n- a `null` value, e.g. when a record's MasterFile has no files\n- an `obsolete value`, e.g. CreatedBy/ModifiedBy that points to a user who was removed from the database\n\nThen clicking that type of link will have the API by default return a `404 NotFound` error containing a meaningful error message. Selecting that type of link will by default have the `propertyname: null` embedded in the output.\n\n### Search expressions\n\nBoth the `filter`/`sort` parameters below and the advanced `/search/records` and `/search/classifications` endpoints use the same Aprimo DAM search expression syntax.\n\n#### Basic syntax\n\nThe simplest expression is `property = value`. Quote values containing spaces:\n\n```\nName = 'Administrator'\n```\n\nCombine criteria with logical operators: `AND` (or `+`), `OR`, `NOT` (or `-`):\n\n```\nName = a* AND CreatedBy.Name = 'John Doe'\n```\n\nAn asterisk (`*`) is a wildcard by default. To match it literally instead, set `supportWildcards: false` on the search expression object (this also affects `?`, which otherwise matches any single character).\n\n#### Operators\n\n| Operator | Description |\n| --- | --- |\n| `=` | Equal to |\n| `>`, `>=` | Greater than / or equal to |\n| `<`, `<=` | Less than / or equal to |\n| `<>` | Not equal to |\n| `in` | Matches one of a list, e.g. `Id IN [\"...\", \"...\"]` |\n| `contains` | Full-text search, e.g. `File.Version.Comment contains \"draft\"` |\n\nOperator support by data type: String (`=`,`>`,`>=`,`<`,`<=`,`<>`,`contains`,`in`), Date/Time (`=`,`>`,`>=`,`<`,`<=`,`<>`,`in`), Guid (`=`,`<>`,`in`), Numeric (`=`,`>`,`>=`,`<`,`<=`,`<>`,`in`), Boolean (`=`,`<>`).\n\n#### Named and unnamed parameters\n\nThe advanced search endpoints (`/search/records`, `/search/classifications`) support parameterizing an expression instead of inlining values - useful for building expressions dynamically. Unnamed parameters (`?`) fill in order from the `parameters` array; named parameters (`@Name`) are filled from `namedParameters` and can be reused:\n\n```json\n{ \"searchExpression\": { \"expression\": \"Name = ? OR Name = ?\", \"parameters\": [\"a*\", \"b*\"] } }\n```\n\n```json\n{ \"searchExpression\": { \"expression\": \"Name = @Word OR Email = @Word\", \"namedParameters\": { \"Word\": \"John Doe\" } } }\n```\n\nThe `filter`/`sort` query-string and header parameters below only support the plain (non-parameterized) form of an expression.\n\n#### Searching by field value\n\nRecords, classifications, and other field-carrying objects store custom metadata in fields. Reference a field's value in a search expression by Id (most stable), Name (readable), or Label (language-dependent, least reliable):\n\n```\nFieldId(\"\").Value = \"...\"\nFieldName(\"BrandName\") = \"ADAM\"\nFieldLabel(\"Brand Name\") = \"ADAM\"\n```\n\nWhich property to use after the field reference depends on the field's data type:\n\n| Field data type | Property | Example |\n| --- | --- | --- |\n| Text, Numeric, Duration | `Value` | `FieldName(\"BasePrice\").Value > 100` |\n| Date/Time | `Value`, `UtcValue` | `FieldName(\"ExpiresOn\").UtcValue < \"2000-01-01T08:00:00Z\"` |\n| Hyperlink | `Url`, `DisplayText` | `FieldName(\"ExternalLinks\").Url = \"https://example.com\"` |\n| Option List | `Option.Id`, `Option.Name`, `Option.Label`, `Option.SortIndex` | `FieldName(\"Status\").Option.Name = \"Draft\"` |\n| Classification List | `Classification.Id` | `FieldName(\"SecondaryClassifications\").Classification.Id = \"...\"` |\n| Language List | `Language.Id` | `FieldName(\"EnabledLanguages\").Language.Id = \"...\"` |\n| Record List | `Record.Id` | `FieldName(\"RelatedProducts\").Record.Id = \"...\"` |\n| User List | `User.Name` | `FieldName(\"Owners\").User.Name = \"Pete Newcase\"` |\n| User Group List | `UserGroup.Id` | `FieldName(\"ManagingRoles\").UserGroup.Id = \"...\"` |\n\n#### Commonly searched/sortable properties\n\nThe property names available on each resource match that resource's own field/property names (see the resource's schema). A few of the most commonly used ones for Records and Classifications:\n\n| Records | Type | Sortable | Notes |\n| --- | --- | --- | --- |\n| `Id` | Guid | Yes | |\n| `Title` | String | Yes | Supports `contains` for partial matches |\n| `ContentStatus` | String | No | e.g. `ContentStatus = \"Published\"` |\n| `ContentType` / `DirectContentType` | String | No | `DirectContentType` excludes child types |\n| `Classification` / `DirectClassification` | Classification | No | `DirectClassification` excludes descendants |\n| `CreatedOn` / `ModifiedOn` | DateTime | Yes | |\n| `CreatedBy` / `ModifiedBy` | User | No | e.g. `CreatedBy.Name = 'John Doe'` |\n| `FileCount` | Number | No | |\n| `Rank` | -- | -- | Sort by relevance: `sort: Rank desc` (Records and Classifications only) |\n\n| Classifications | Type | Sortable | Notes |\n| --- | --- | --- | --- |\n| `Id` | Guid | Yes | |\n| `Label` | String | Yes | |\n| `Name` | String | Yes | |\n| `NamePath` | String | No | e.g. `NamePath = '/Books/Published'` |\n| `Identifier` | String | Yes | |\n\n### Filtering\n\nA filter expression can be passed in the request with the `filter` parameter. It can be specified as a query string or a header parameter. The parameter is only taken into account on collections of resources.\n\nA filter expression is a single-line Aprimo DAM search expression without parameters or any additional options. See Search expressions above for more details.\n\n**Warning:** Searching for records/classifications using a search expression is done in 2 steps: first ElasticSearch is queried to get a list of matching IDs, then those IDs are used to query the Aprimo DAM database.\nIf any of the search results is deleted between step 1 and 2, the TotalCount value will be out of sync with the real count of search results.\n\n### Sorting\n\nA sort expression can be passed in the request with the `sort` parameter. It can be specified in the query string or as a header. The parameter is only taken into account on collections of resources. See Search expressions above for more details.\n\n### Paging\n\nWhen paging through a collection, choose a mechanism in this order of preference:\n\n1. **Cursor** (records search only) - the **preferred** way to page sequentially. It is the fastest and most efficient option, with constant cost no matter how deep you page.\n2. **Skip & take** - offset-based access, for when you need to jump to an arbitrary position rather than walk pages in order.\n3. **Page & pageSize** - the older offset mechanism, still supported on most routes.\n\n**Cursor pagination (records search only) - preferred.**\nBoth `POST /search/records` and `GET /records` support an optional `cursor` parameter. When paging sequentially this is the fastest and most efficient option: the server resumes from the cursor position instead of an offset, so per-page cost stays constant regardless of how deep in the result set you are. Offset paging gets slower the deeper you go; cursor paging does not. Whenever you walk through records in order, use the cursor.\n\nResponses include a `nextCursor` field when a full page was returned (more records may exist). When `nextCursor` is `null`, you have reached the last page. The cursor is opaque - treat it as a black box and pass it back verbatim.\n\nThe cursor is bound to the sort order, filter expression, and tenant of the request that minted it. Keep the sort and filter identical on every page; sending a cursor with a different sort, filter, or tenant context returns `400 Bad Request`.\n\n**Worked example - walking all records 100 at a time:**\n\nPage 1 - no cursor:\n\n```json\nPOST /search/records?pageSize=100\n{ \"searchExpression\": { \"expression\": \"ContentType='Asset'\" } }\n\nResponse:\n{\n \"totalCount\": 1500,\n \"items\": [ \"...100 records...\" ],\n \"nextCursor\": \"eyJ2IjoxLCJzIjpbIjIwMjYtMDUtMDEiLCJhYmMxMjMiXSwiaCI6ImZmZTI...\"\n}\n```\n\nPage 2 - pass cursor back, same sort and filter:\n\n```json\nPOST /search/records?pageSize=100\n{\n \"searchExpression\": { \"expression\": \"ContentType='Asset'\" },\n \"cursor\": \"eyJ2IjoxLCJzIjpbIjIwMjYtMDUtMDEiLCJhYmMxMjMiXSwiaCI6ImZmZTI...\"\n}\n\nResponse:\n{\n \"totalCount\": 1500,\n \"items\": [ \"...next 100 records...\" ],\n \"nextCursor\": \"eyJ2IjoxLCJzIjpbIjIwMjYtMDYtMDEiLCJkZWYxMjMiXSwiaCI6ImFiYzE...\"\n}\n```\n\nContinue until `nextCursor` is `null` - last page reached.\n\nFor `GET /records`, pass the cursor as a query string parameter and keep the same `filter` and `sort` on every page (they are part of what the cursor is bound to): `GET /records?pageSize=100&filter=...&sort=...&cursor=eyJ2Ij...`\n\n**Skip & take (second option).**\nUse these for offset-based access when you are not walking pages in order. `skip` bypasses a specified number of results; `take` specifies how many to return (both int32). Newer or more recently updated routes preferentially support skip/take and may not support page/pageSize.\n\n**Page & pageSize.** The older offset mechanism: provide `page` and/or `pageSize` as query string or header parameters. Pre-built relation links (`first`, `prev`, `next`, `last`) are also available. For performance the `pageSize` limit is 1000; when omitted it defaults to 50. See Search expressions above for more details.\n\n**Per-route page-size limits.** Some routes apply a stricter cap than the global 1000 limit. Records search (`POST /search/records` and `GET /records`) clamps `pageSize` / `take` at **100**. Requests above the cap are silently clamped, exactly like the existing 1000 cap on other routes; no error is returned. All other paged endpoints continue to use the global 1000 limit.\n\n### Relations\n\nThe following registered relations are used: \"`self`\", \"`first`\", \"`prev`\", \"`next`\" and \"`last`\" (as specified in the [Web Linking RFC](https://www.iana.org/assignments/link-relations/link-relations.xhtml)). Other custom relations are added per resource to allow intuitive navigation of the Rest API.\n\nNote that not all entities, which are exposed as resources through the Rest API, are returned as relations if referenced by another entity. For small and static collections, such as languages, the client application should fetch and cache the list of resources at startup and then map the Ids to resources on the client-side. These resources are not returned as relations but as plain GUIDs.\n\n### Localization\n\nFields and labels can be requested in specific languages using the `languages` header parameter. This parameter can be a single language Id, a comma-separated list of language IDs or an asterisk (\"*\") that represents all languages. If omitted, this parameter will return the current user's default language.\n\n### Exception handling\n\nWhen unexpected exceptions occur, the Aprimo DAM REST API will feed this back to the API consumer via an HTTP error response containing an exception object as body. The HTTP response code will correspond to the type of exception that occurred:\n\n- HTTP 4xx response codes indicate specific error conditions (validation errors, malformatted requests, access denied, resource not available...)\n- HTTP 500 internal server error is returned for all other exceptions\n\nThe error object returned can contain the following properties:\n\n| Property | Description |\n| --- | --- |\n| `exceptionMessage` | A description of what went wrong. Depending on the exception this can be a technical or a more user-friendly message. |\n| `exceptionType` | The full type name of the exception. This can be used in automatic error handling or to reinstantiate the exception on the client. |\n\n**Exception:** `504 Gateway Timeout` and `429 Too Many Requests` responses are returned as HTML, not the JSON error object described above - a client that unconditionally parses error bodies as JSON must special-case these two status codes.\n\n### Downloading files\n\nWhen downloading a file using a link returned by an Order or a `URI` property of an Image resource, the file name is not always known upfront. This can be the case, e.g. when a resize action is applied during the ordering of an object, because that action changes the file name.\n\nDownload URI will contain a security token set to expire:\n\n- after 30 hours, if default File store is configured to use disk as a storage.\n- not sooner than the value of the setting `.minimumAvailableTimeForPreviews` (for **/additionalfile**, **/image/preview** and **/image/thumbnail** endpoints) or `.minimumAvailableTimeForOrders` (for download orders) (See the DAM Operations help for more information), if the default File store is configured to use Azure blob storage.\n\nThe download URI can return:\n\n- file content\n- a redirect to the proper file location in case CDN is enabled. It then responds with the http status code \"MovedPermanently\" (301) or \"Redirect\" (302)\".\n\nIt is possible to specify CDN location by setting the value of the optional `Location-Alias` header. Used values:\n\n- `us1` - for South America, Antarctica, North America, Central America, Caribbean\n- `eu2` - for Europe, Africa, Middle East\n- `au1` - for Australia, Pacific, Asia (except China)\n- `cn1` - for China\n\nFor reference, the `Content-Disposition` header is added to the response, and contains the file name, e.g. `Content-Disposition: attachment; filename=\"fname.ext\"`\n\nFor more information, see [RFC 6266](https://www.rfc-editor.org/rfc/rfc6266).\n\n## Usage\n\n### Authentication\n\nThe Aprimo DAM REST API uses the OAuth 2.0 [Client Credentials](https://www.rfc-editor.org/rfc/rfc6749#section-4.4) flow. Exchange a client id/secret for a bearer access token, then send that token as a [Bearer authentication](https://www.rfc-editor.org/rfc/rfc6750) `Authorization` header on every subsequent request.\n\nThere are several endpoints in the Aprimo DAM REST API that do not require authentication. You can find them in the Endpoint header requirements section.\n\n#### Requesting an access token\n\n```http\nPOST https://{aprimoDomain}.aprimo.com/login/connect/token\nContent-Type: application/x-www-form-urlencoded\n\ngrant_type=client_credentials&scope=api&client_id={clientId}&client_secret={clientSecret}\n```\n\n```json\n{\n \"access_token\": \"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...\",\n \"expires_in\": 3600,\n \"token_type\": \"Bearer\",\n \"scope\": \"api\"\n}\n```\n\n`expires_in` is in seconds (3600 = 1 hour). Request a new token before the current one expires; there is no refresh-token flow for client credentials - simply repeat the request above.\n\n#### Using the access token\n\nSend the obtained `access_token` as a Bearer token on the `Authorization` header of every REST API request:\n\n```http\nGET /records\nAuthorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...\nAPI-VERSION: 1\nAccept: application/hal+json\n```\n\n### Endpoint header requirements\n\nThe following table gives an overview of which header fields are required for all endpoints:\n\n| Endpoint | API-VERSION | Accept | Authorization | User-Agent |\n| --- | --- | --- | --- | --- |\n| / (root) | Ignored | Required | Ignored | Required |\n| /supportedVersions | Ignored | Required | Ignored | Required |\n| /download | Ignored | Ignored | Ignored | Required |\n| /docs | Ignored | Ignored | Ignored | Ignored |\n| all other endpoints | Required | Required | Required | Required |\n\n### Editing resources\n\nAprimo DAM REST API, among other features, supports editing of resources. In order to create a new resource, you need to perform a `POST` request on a collection to which you want to add a new resource. Performing a `PUT` request updates an existing resource and issuing a `DELETE` request deletes an existing resource. You need to have appropriate privileges in order to perform these requests.\n\nIn most cases, you can reuse the response (in application/json format) of the read operation to provide that response as a request body for the edit requests.\n\nAlso, in most cases, setting a resource's property to null resets its value (like \"tag\" for example).\n\nFor changing the nested collections, you can use `addOrUpdate` and `remove` sections in the collections request, which contain id's of elements which have to be added/updated (removed) in (from) nested collections.\n\nEach resource contains an \"Examples\" section on its documentation page, which provides more info on how to properly perform editing requests on that resource.\n\n### Uploading files\n\nFiles should be uploaded through the upload service. The upload service is a dedicated service made for uploading files only. Each file that you upload through the upload service can be added to a record. Do note that each uploaded file should be used only once. After the uploaded file has been used by this API a cleanup service will remove the upload from the storage location. The upload service implements 3 approaches to upload files. An http upload for small files (smaller than 20 MB), an http upload for big files (larger than 20 MB) and a direct upload to the blob storage using AzCopy.\n\n#### Filename restrictions\n\nThe following characters are not supported in a filename:\n`< > : \" / \\ | ? *`\n\n#### Uploading files below 20 MB\n\nUploading a file through the Aprimo Upload Service is done in the following way:\n\n```http\nPOST [CustomerURL]/uploads\n```\n\n\".RoleExecuteMaintenanceJobs\" and \".RoleViewMaintenanceJobs\" privileges are required for users that want to process uploaded files through this API, due to the internal implementation.\n\nRight now only multipart form-data content-type is supported. This means that you cannot simply `POST` binary stream to `/uploads` endpoint. Instead, you produce proper multipart form-data request. However, multipart form-data is the default format for modern HTTP clients, so crafting such a request should not be a problem. The multipart form-data request looks similar to this:\n\n```http\nPOST [CustomerURL]/uploads\nContent-Length: 244947\nUser-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) ...\napi-version: 1\nAuthorization: Bearer eyJ0e...(base64-encoded JWT security token)...jrzpAg\nContent-Type: multipart/form-data; boundary=----BoundaryzZaqkP0Sxn4p9XFF\nAccept: */*\n------BoundaryzZaqkP0Sxn4p9XFF\nContent-Disposition: form-data; name=\"file1\"; filename=\"Logo_flame.png\"\nContent-Type: image/png\n[binary content]\n```\n\nCurrently only one file per request is supported, even though the format allows the multi-upload.\n\nWhen successful, either a HTTP 200 OK response is returned, or a HTTP 202 Accepted response. If the response is 200 OK, it contains a file upload token which can then be used in e.g. the edit record file request. There is also direct access to the file through a sasUrl.\n\n```json\n{\n \"token\":\"eyJQGXRoIjoicWE1LXJjLzg4NDZqZTZiZDY4MzQxZjY4YjI5NWE5ZWFkZGE0MmZmL21pa2UucG5nIiwiVm9sdW1lSWQiOzI0OTA2MmFiZC1mYmYxLTgwMTYtYTMwYS1iYjdkYWQ2ODM4YzIifQ==\",\n \"sasUrl\":\"https://[blobstoragename].blob.core.windows.net/[customer specific container]/8846be6bd68341f68b295a9eadda42ff/Logo_flame.png?sv=2024-11-04&st=2026-01-22T11%3A08%3A00Z&se=2026-01-23T11%3A23%3A00Z&sr=b&sp=rwl&sig=gk6sZCYl0cBffPKNhyWJCdmhVWC2vfKeIyZDu21yGlU%3D\"\n}\n```\n\n#### Uploading files above 20 MB - in segments\n\n1. Prepare file segments to upload.\n2. Set up the upload\n3. Upload each segment\n4. Commit the upload\n5. Cancel the upload\n\n##### 1. Prepare the file segments to upload\n\nThis is the responsibility of the consumer of the API. This depends on the technology in which the client program is written.\n\n##### 2. Set up the upload\n\nThis is meant to notify the server that an upload flow is initiated by the client.\n\n```http\nPOST [CustomerURL]/uploads/segments\nUser-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) ...\napi-version: 1\nAuthorization: Bearer eyJ0e...(base64-encoded JWT security token)...jrzpAg\nAccept: */*\nContent-Type: application/json\n{\n \"filename\":\"photo.png\"\n}\n```\n\nWhen successful, the response will have HTTP Response Code 200 OK and will contain a URI which can be used to upload the file segments in the next step.\n\n```json\n{\n \"uri\":\"/uploads/segments/NzVmMDY5YTA4MGU1NDBhMDkyY2FmYzQ3YzQwMzNjMmQ%3d\",\n \"token\": \"NzVmMDY5YTA4MGU1NDBhMDkyY2FmYzQ3YzQwMzNjMmQ=\"\n}\n```\n\n##### 3. Upload each segment\n\nIn this step, each segment of the file will be uploaded to the URI provided returned in the response in the previous step.\n\nThe name of the file provided in the upload form is not important.\n\nThe client needs to specify the index of the uploaded segment as a query string parameter.\n\n**The index of the segment is ZERO based.**\n\nThere should be one segment with index=0 and there should be no gaps between indexes.\n\n```http\nPOST [CustomerURL]/uploads/segments/NzVmMDY5YTA4MGU1NDBhMDkyY2FmYzQ3YzQwMzNjMmQ%3d?index=0\nContent-Length: 24947\nUser-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) ...\napi-version: 1\nAuthorization: Bearer eyJ0e...(base64-encoded JWT security token)...jrzpAg\nContent-Type: multipart/form-data; boundary=----BoundaryzZaqkP0Sxn4p9XFF\nAccept: */*\n------BoundaryzZaqkP0Sxn4p9XFF\nContent-Disposition: form-data; name=\"segment0\"; filename=\"Logo_flame.png.segment0\"\nContent-Type: image/png\n[binary content]\n```\n\nThis step needs to be repeated for every segment of the file. It is possible to upload different file segments in parallel requests.\n\nWhen successful, the response will have HTTP Response Code 202 Accepted.\n\n##### 4. Commit the upload\n\nAfter all the segments have been uploaded, the upload flow can be committed.\n\nThe client needs to provide the total number of segments which have been uploaded and the name of the original file.\n\n```http\nPOST [CustomerURL]/uploads/segments/NzVmMDY5YTA4MGU1NDBhMDkyY2FmYzQ3YzQwMzNjMmQ%3d/commit\nUser-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) ...\napi-version: 1\nAuthorization: Bearer eyJ0e...(base64-encoded JWT security token)...jrzpAg\nAccept: */*\nContent-Type: application/json\n{\n \"filename\":\"photo.png\",\n \"segmentcount\":\"4\"\n}\n```\n\nIn this step validation will occur which will make sure that all the file segments have been uploaded to the server.\n\nIn case all the file segments are present, the file will be re-assembled from fragments and will persist on the server.\n\nWhen successful, a HTTP 200 OK response is returned. If the response is 200 OK, it contains a file upload token which can then be used in e.g. the edit record file request. There is also direct access to the file through a sasUrl.\n\n```json\n{\n \"token\":\"eyJQGXRoIjoicWE1LXJjLzg4NDZqZTZiZDY4MzQxZjY4YjI5NWE5ZWFkZGE0MmZmL21pa2UucG5nIiwiVm9sdW1lSWQiOzI0OTA2MmFiZC1mYmYxLTgwMTYtYTMwYS1iYjdkYWQ2ODM4YzIifQ==\",\n \"sasUrl\":\"https://[blobstoragename].blob.core.windows.net/[customer specific container]/8846be6bd68341f68b295a9eadda42ff/photo.png?sv=2024-11-04&st=2026-01-22T11%3A08%3A00Z&se=2026-01-23T11%3A23%3A00Z&sr=b&sp=rwl&sig=gk6sZCYl0cBffPKNhyWJCdmhVWC2vfKeIyZDu21yGlU%3D\"\n}\n```\n\n##### 5. Cancel the segmented upload\n\nAn upload flow can be cancelled at any moment after its setup was executed.\n\n```http\nDELETE [CustomerURL]/uploads/segments/NzVmMDY5YTA4MGU1NDBhMDkyY2FmYzQ3YzQwMzNjMmQ%3d\nUser-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) ...\napi-version: 1\nAuthorization: Bearer eyJ0e...(base64-encoded JWT security token)...jrzpAg\nAccept: */*\n```\n\nWhen successful, the response will have HTTP Response Code 204 No Content.\n\n#### Uploading files directly to the blob storage\n\nIt is possible to upload a file directly to the blob storage using AzCopy, bypassing the http upload service. AzCopy is a command-line utility developed by Microsoft that you can use to copy blobs or files to a storage account. An http call to the upload service is still required to create a writable location on the blob storage. The returned sasUrl can be used to upload the file with AzCopy:\n\n```http\nPOST [CustomerURL]/uploads\n```\n\nCurrently only one file per request is supported.\n\n```http\nPOST /uploads\nAuthorization: Bearer eyJ0e...(base64-encoded JWT security token)...jrzpAg\napi-version: 1\nContent-Type: application/json\n\n{\n \"fileName\" : \"bigfile.psd\"\n}\n```\n\nWhen successful, a HTTP 200 OK response is returned. It contains a file upload token which can then be used in the REST API, e.g. the edit record file request.\n\n```json\n{\n \"token\":\"eyJQGXRoIjoicWE1LXJjLzg4NDZqZTZiZDY4MzQxZjY4YjI5NWE5ZWFkZGE0MmZmL21pa2UucG5nIiwiVm9sdW1lSWQiOzI0OTA2MmFiZC1mYmYxLTgwMTYtYTMwYS1iYjdkYWQ2ODM4YzIifQ==\",\n \"sasUrl\":\"https://[blobstoragename].blob.core.windows.net/[customer specific container]/8846be6bd68341f68b295a9eadda42ff/bigfile.psd?sv=2024-11-04&st=2026-01-22T11%3A08%3A00Z&se=2026-01-23T11%3A23%3A00Z&sr=b&sp=rwl&sig=gk6sZCYl0cBffPKNhyWJCdmhVWC2vfKeIyZDu21yGlU%3D\"\n}\n```\n\nKeep in mind that the token can only be used after the file has finished uploading. The AzCopy command would look like this:\n\n```\nazcopy copy \"C:\\path\\to\\local\\file\\bigfile.psd\" \"https://blobstoragename.blob.core.windows.net/local-uploads/65c369ac-6b5c-4e19-b2c4-bf826f74ab6d/bigfile.psd?sv=2017-04-17&sr=c&sig=oINgt6eKwnOYNnDVJB4qHZxylqLzGERbHdo892KCUuc%3D&st=2020-05-05T13%3A49%3A39Z&se=2020-05-06T14%3A04%3A39Z&sp=rwl\"\n```\n\n#### Cleaning the uploads\n\nEvery file that is uploaded to the upload service is automatically cleaned up after a few days. This means that the tokens you receive back in the upload response are not valid after the cleanup.\n", "version": "1" }, "servers": [ { "url": "/api/core" } ], "paths": { "/accesslist/{accessListId}": { "get": { "tags": [ "Access list" ], "summary": "Read an access list by its id", "operationId": "getAccesslistByAccessListId", "parameters": [ { "name": "accessListId", "in": "path", "description": "id of the access list", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessListResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "put": { "tags": [ "Access list" ], "summary": "Update an access list by its id", "operationId": "updateAccesslistByAccessListId", "parameters": [ { "name": "accessListId", "in": "path", "description": "The id of the access list", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessListEditByIdCommand" } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "delete": { "tags": [ "Access list" ], "summary": "Delete an access list by its id", "operationId": "deleteAccesslistByAccessListId", "parameters": [ { "name": "accessListId", "in": "path", "description": "The id of the access list", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/accesslist": { "get": { "tags": [ "Access list" ], "summary": "Read an access list by its externalId, permission, and type", "operationId": "getAccesslist", "parameters": [ { "name": "externalId", "in": "query", "description": "The externalId of the access list", "required": true, "schema": { "type": "string" } }, { "name": "permission", "in": "query", "description": "The permission of the access list", "required": true, "schema": { "enum": [ "Read", "Modify", "Delete", "FullControl" ], "type": "string" } }, { "name": "type", "in": "query", "description": "The type of the access list", "required": true, "schema": { "type": "string" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessListResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "put": { "tags": [ "Access list" ], "summary": "Update an access list by its externalId, permission, and type", "operationId": "updateAccesslist", "parameters": [ { "name": "externalId", "in": "query", "description": "The externalId of the access list", "required": true, "schema": { "type": "string" } }, { "name": "permission", "in": "query", "description": "The permission of the access list", "required": true, "schema": { "enum": [ "Read", "Modify", "Delete", "FullControl" ], "type": "string" } }, { "name": "type", "in": "query", "description": "The type of the access list", "required": true, "schema": { "type": "string" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessListEditByUniqueParamsCommand" } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "delete": { "tags": [ "Access list" ], "summary": "Delete an access list by its externalId, permission, and type", "operationId": "deleteAccesslist", "parameters": [ { "name": "externalId", "in": "query", "description": "The externalId of the access list", "required": true, "schema": { "type": "string" } }, { "name": "permission", "in": "query", "description": "The permission of the access list", "required": true, "schema": { "enum": [ "Read", "Modify", "Delete", "FullControl" ], "type": "string" } }, { "name": "type", "in": "query", "description": "The type of the access list", "required": true, "schema": { "type": "string" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/accesslists": { "get": { "tags": [ "Access list" ], "summary": "Read a collection of accessLists", "operationId": "getAccesslists", "parameters": [ { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "A filter expression restricting which items are returned, e.g. \"ModifiedOn in today\". Omit to return all items the caller may see. The query parameter is the canonical location for this filter; the same value may alternatively be sent as a same-named request header.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "The property to sort by, optionally suffixed to control direction, e.g. \"createdOn\". Omit for the endpoint's default order. May also be sent as a same-named request header.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "1-based page number, used together with \"pageSize\". Defaults to the first page. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Number of items per page, used together with \"page\". Too high values will be capped. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of items to skip, used together with \"take\" as an alternative to \"page\"/\"pageSize\". May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "take", "in": "query", "description": "Number of items to return, used together with \"skip\" as an alternative to \"page\"/\"pageSize\". Too high values will be capped. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "$ref": "#/components/mediaTypes/IPagedCollectionResourceOfAccessListResourceJson" }, "application/hal+json": { "$ref": "#/components/mediaTypes/IPagedCollectionResourceOfAccessListResourceHal" } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "post": { "tags": [ "Access list" ], "summary": "Create a new access list", "operationId": "createAccesslists", "parameters": [ { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessListCreateCommand" } } }, "required": true }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatedResourceId" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/actiontype/{actionTypeId}": { "get": { "tags": [ "Action type" ], "summary": "Read an action type", "description": "### Examples\n\nAction types define the behavior and configuration for checks.\n\n```http\nGET /actiontypes/12345678-1234-1234-1234-123456789012\naccept: application/hal+json\n```", "operationId": "getActiontypeByActionTypeId", "parameters": [ { "name": "actionTypeId", "in": "path", "description": "id of the action type", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionTypeResource" }, "example": { "_links": { "self": { "href": "/actiontypes/12345678-1234-1234-1234-123456789012" } }, "id": "12345678-1234-1234-1234-123456789012", "name": "external default" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/actiontypes": { "get": { "tags": [ "Action type" ], "summary": "Read all action types", "description": "### Examples\n\nReading all action types\n\n```http\nGET /actiontypes\naccept: application/hal+json\n```", "operationId": "getActiontypes", "parameters": [ { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "A filter expression restricting which items are returned, e.g. \"ModifiedOn in today\". Omit to return all items the caller may see. The query parameter is the canonical location for this filter; the same value may alternatively be sent as a same-named request header.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "The property to sort by, optionally suffixed to control direction, e.g. \"createdOn\". Omit for the endpoint's default order. May also be sent as a same-named request header.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "1-based page number, used together with \"pageSize\". Defaults to the first page. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Number of items per page, used together with \"page\". Too high values will be capped. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of items to skip, used together with \"take\" as an alternative to \"page\"/\"pageSize\". May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "take", "in": "query", "description": "Number of items to return, used together with \"skip\" as an alternative to \"page\"/\"pageSize\". Too high values will be capped. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionTypeCollectionResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/additionalfile/{additionalFileId}": { "get": { "tags": [ "Additional file" ], "summary": "Read an additional file", "operationId": "getAdditionalfileByAdditionalFileId", "parameters": [ { "name": "additionalFileId", "in": "path", "description": "id of the additional file", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/CropResource" }, { "$ref": "#/components/schemas/TrimResource" }, { "$ref": "#/components/schemas/StillResource" }, { "$ref": "#/components/schemas/SpinsetResource" }, { "$ref": "#/components/schemas/ThreeDimensionalFileResource" }, { "$ref": "#/components/schemas/SubtitleResource" }, { "$ref": "#/components/schemas/ExternalFileResource" }, { "$ref": "#/components/schemas/CustomFileResource" }, { "$ref": "#/components/schemas/VideoPersonThumbnailResource" }, { "$ref": "#/components/schemas/AdditionalFileResource" } ] } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/additionalfile/{additionalFileId}/filepreviews": { "get": { "tags": [ "Additional file" ], "summary": "Read all previews of an additional file", "operationId": "getAdditionalfileFilepreviewsByAdditionalFileId", "parameters": [ { "name": "additionalFileId", "in": "path", "description": "id of the additional file", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "$ref": "#/components/mediaTypes/AdditionalFilePreviewCollectionResourceJson" }, "application/hal+json": { "$ref": "#/components/mediaTypes/AdditionalFilePreviewCollectionResourceHal" } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/additionalfile/{additionalFileId}/preview": { "get": { "tags": [ "Additional file" ], "summary": "Read the main image preview of the additional file", "operationId": "getAdditionalfilePreviewByAdditionalFileId", "parameters": [ { "name": "additionalFileId", "in": "path", "description": "id of the additional file", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImageResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/additionalfile/{additionalFileId}/publiclink": { "get": { "tags": [ "Additional file" ], "summary": "Read the public link for the additional file", "operationId": "getAdditionalfilePubliclinkByAdditionalFileId", "parameters": [ { "name": "additionalFileId", "in": "path", "description": "id of the additional file", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicLinkResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/additionalfile/{additionalFileId}/filePreviews/{filePreviewId}": { "get": { "tags": [ "Additional file" ], "summary": "Read preview of an additional file", "operationId": "getAdditionalfileFilePreviewsByAdditionalFileIdAndFilePreviewId", "parameters": [ { "name": "additionalFileId", "in": "path", "description": "id of the additional file", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "filePreviewId", "in": "path", "description": "id of the additional file preview", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/AdditionalFilePreviewResource" }, { "$ref": "#/components/schemas/ImageResource" } ] } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/annotation/{annotationId}": { "get": { "tags": [ "Annotation" ], "summary": "Read an annotation", "operationId": "getAnnotationByAnnotationId", "parameters": [ { "name": "annotationId", "in": "path", "description": "id of the annotation", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnnotationResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/annotations": { "get": { "tags": [ "Annotation" ], "summary": "Read a collection of annotations", "operationId": "getAnnotations", "parameters": [ { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "A filter expression restricting which items are returned, e.g. \"ModifiedOn in today\". Omit to return all items the caller may see. The query parameter is the canonical location for this filter; the same value may alternatively be sent as a same-named request header.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "The property to sort by, optionally suffixed to control direction, e.g. \"createdOn\". Omit for the endpoint's default order. May also be sent as a same-named request header.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "1-based page number, used together with \"pageSize\". Defaults to the first page. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Number of items per page, used together with \"page\". Too high values will be capped. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of items to skip, used together with \"take\" as an alternative to \"page\"/\"pageSize\". May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "take", "in": "query", "description": "Number of items to return, used together with \"skip\" as an alternative to \"page\"/\"pageSize\". Too high values will be capped. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "$ref": "#/components/mediaTypes/IPagedCollectionResourceOfAnnotationResourceJson" }, "application/hal+json": { "$ref": "#/components/mediaTypes/IPagedCollectionResourceOfAnnotationResourceHal" } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "post": { "tags": [ "Annotation" ], "summary": "Create a new annotation", "operationId": "createAnnotations", "parameters": [ { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnnotationCreateCommand" } } }, "required": true }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatedResourceId" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/CalculatedPermission/{CalculatedPermissionName}": { "get": { "tags": [ "Calculated permission" ], "summary": "Read a calculated permission by its name", "description": "### Examples\n\nReading a calculated permission\n\n```http\nGET /calculatedpermission/MyRolePermission\n```", "operationId": "getCalculatedPermissionByCalculatedPermissionName", "parameters": [ { "name": "CalculatedPermissionName", "in": "path", "description": "name of the permission", "required": true, "schema": { "type": "string" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CalculatedPermissionResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/calculatedpermissions": { "get": { "tags": [ "Calculated permission" ], "summary": "Read a collection of calculated permissions with names in the query string", "description": "### Examples\n\nGetting multiple calculated permissions\n\nUse the \"**names**\" query parameter to specify a comma-separated list of permission names.\n\nFor example:\n\n```http\nGET /calculatedpermissions?names=.RoleSubmitMaintenanceJobs,.RoleCanUploadMultipleFiles\nAccept: application/hal+json\n```", "operationId": "getCalculatedpermissions", "parameters": [ { "name": "names", "in": "query", "description": "A comma separated list of calculated permission names to look up.", "schema": { "type": "string" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CalculatedPermissionResource" } } }, "description": "A paged/collection response envelope." } }, "application/hal+json": { "schema": { "required": [ "_links" ], "type": "object", "properties": { "_links": { "type": "object", "properties": { "self": { "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/CalculatedPermissionResource" } } }, "description": "A paged/collection response envelope." } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "post": { "tags": [ "Calculated permission" ], "summary": "Read a collection of calculated permissions with names in the body", "description": "Read a collection of calculated permissions with names in the body. This is a read/query operation, not a create: it returns the same data as the sibling GET /calculatedpermissions, only with the permission names supplied in the request body instead of the \"names\" query parameter. POST is used here purely because the list of permission names can be long enough to exceed a query-string length limit; the call creates and modifies nothing.", "operationId": "createCalculatedpermissions", "parameters": [ { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PermissionFilterModel" }, "example": { "names": [ "SomePermissionName", "AnotherPermissionName" ] } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CalculatedPermissionResource" } } }, "description": "A paged/collection response envelope." }, "example": [ { "name": "SomePermissionName", "value": "Granted" }, { "name": "AnotherPermissionName", "value": "None" } ] }, "application/hal+json": { "schema": { "required": [ "_links" ], "type": "object", "properties": { "_links": { "type": "object", "properties": { "self": { "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/CalculatedPermissionResource" } } }, "description": "A paged/collection response envelope." } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/checks/{checkId}": { "get": { "tags": [ "Check" ], "summary": "Read a check", "description": "### Examples\n\nReading a check\n\n```http\nGET /checks/abcd8e8h09e8fg4e785e7gh4403f009\naccept: application/hal+json\n```", "operationId": "getChecksByCheckId", "parameters": [ { "name": "checkId", "in": "path", "description": "id of the check", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CheckResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "put": { "tags": [ "Check" ], "summary": "Update a check", "description": "### Examples\n\nUpdating a check\n\nThe ModifiedBy field is automatically set from the authenticated user context for security. Multi-language labels can be updated to support internationalization. All fields are optional for partial updates.\n\n```http\nPUT /checks/abcd8e8h09e8fg4e785e7gh4403f009\ncontent-type: application/json\n```\n\n```json\n{\n\t\"name\": \"Enhanced Security Scan\",\n\t\"actionTypeId\": \"22caecb7-df49-446b-9ef8-c6838b3a309e\",\n\t\"checkCategoryId\": \"0fab5339-2911-4022-81be-15afa12dd7e1\",\n\t\"labels\": [\n\t\t{\n\t\t\t\"value\": \"Enhanced Security Scan\",\n\t\t\t\"languageId\": \"C2BD4F9B-BB95-4BCB-80C3-1E924C9C26DC\"\n\t\t}\n\t]\n}\n```", "operationId": "updateChecksByCheckId", "parameters": [ { "name": "checkId", "in": "path", "description": "id of the check", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCheckCommand" } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "delete": { "tags": [ "Check" ], "summary": "Delete a check", "description": "### Examples\n\nDeleting a check\n\nThe deletion will fail if:\n- The check is marked as non-deletable (IsDeletable flag is false)\n- The check has associated file version check results (database foreign key constraint)\nIn both cases, a 400 Bad Request error will be returned with an appropriate error message.\n\n```http\nDELETE /checks/abcd8e8h09e8fg4e785e7gh4403f009\n```", "operationId": "deleteChecksByCheckId", "parameters": [ { "name": "checkId", "in": "path", "description": "id of the check", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/checks": { "get": { "tags": [ "Check" ], "summary": "Read all checks", "description": "### Examples\n\nReading all checks\n\n```http\nGET /checks\naccept: application/hal+json\n```", "operationId": "getChecks", "parameters": [ { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "A filter expression restricting which items are returned, e.g. \"ModifiedOn in today\". Omit to return all items the caller may see. The query parameter is the canonical location for this filter; the same value may alternatively be sent as a same-named request header.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "The property to sort by, optionally suffixed to control direction, e.g. \"createdOn\". Omit for the endpoint's default order. May also be sent as a same-named request header.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "1-based page number, used together with \"pageSize\". Defaults to the first page. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Number of items per page, used together with \"page\". Too high values will be capped. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of items to skip, used together with \"take\" as an alternative to \"page\"/\"pageSize\". May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "take", "in": "query", "description": "Number of items to return, used together with \"skip\" as an alternative to \"page\"/\"pageSize\". Too high values will be capped. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "title": "Check collection resource", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CheckResource" }, "description": "A collection of resource items." } }, "description": "Representation of a Check Collection" } }, "application/hal+json": { "schema": { "required": [ "_links" ], "$ref": "#/components/schemas/CheckCollectionResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "post": { "tags": [ "Check" ], "summary": "Create a new check", "description": "### Examples\n\nCreating a check\n\nThe CreatedBy field is automatically set from the authenticated user context for security. Multi-language labels can be provided to support internationalization.\n\nSee the `Creating a check (json)` and `Creating a check (hal+json)` response examples in the responses panel.\n\n```http\nPOST /checks\ncontent-type: application/json\naccept: application/hal+json\n```", "operationId": "createChecks", "parameters": [ { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCheckCommand" } } }, "required": true }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatedResourceId" }, "examples": { "creating-a-check": { "summary": "Creating a check (json)", "value": { "name": "Security Scan", "actionTypeId": "22caecb7-df49-446b-9ef8-c6838b3a309e", "checkCategoryId": "0fab5339-2911-4022-81be-15afa12dd7e1", "labels": [ { "value": "Security Scan", "languageId": "C2BD4F9B-BB95-4BCB-80C3-1E924C9C26DC" }, { "value": "Scan de sécurité", "languageId": "691A7C86-57DC-4330-A512-C616DB954D6A" } ] } }, "creating-a-check-2": { "summary": "Creating a check (hal+json)", "value": { "_links": { "self": { "href": "/checks/abcd8e8h09e8fg4e785e7gh4403f009" } }, "id": "abcd8e8h09e8fg4e785e7gh4403f009", "name": "Security Scan", "actionTypeId": "22caecb7-df49-446b-9ef8-c6838b3a309e", "checkCategoryId": "0fab5339-2911-4022-81be-15afa12dd7e1", "labels": { "items": [ { "value": "Security Scan", "languageId": "C2BD4F9B-BB95-4BCB-80C3-1E924C9C26DC" }, { "value": "Scan de sécurité", "languageId": "691A7C86-57DC-4330-A512-C616DB954D6A" } ] }, "createdOn": "2024-01-15T11:00:00.000Z", "createdBy": "12345678-1234-1234-1234-123456789012" } } } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/checkcategories/{checkCategoryId}": { "get": { "tags": [ "Check category" ], "summary": "Read a check category", "description": "### Examples\n\nReading a check category\n\n```http\nGET /checkcategories/7890d7d6g98d7ef3d674d6fg3392e998\naccept: application/hal+json\n```", "operationId": "getCheckcategoriesByCheckCategoryId", "parameters": [ { "name": "checkCategoryId", "in": "path", "description": "id of the check category", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CheckCategoryResource" }, "example": { "_links": { "self": { "href": "/checkcategories/7890d7d6g98d7ef3d674d6fg3392e998" } }, "id": "7890d7d6g98d7ef3d674d6fg3392e998", "name": "Security" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/checkcategories": { "get": { "tags": [ "Check category" ], "summary": "Read all check categories", "description": "### Examples\n\nReading all check categories\n\n```http\nGET /checkcategories\naccept: application/hal+json\n```", "operationId": "getCheckcategories", "parameters": [ { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "A filter expression restricting which items are returned, e.g. \"ModifiedOn in today\". Omit to return all items the caller may see. The query parameter is the canonical location for this filter; the same value may alternatively be sent as a same-named request header.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "The property to sort by, optionally suffixed to control direction, e.g. \"createdOn\". Omit for the endpoint's default order. May also be sent as a same-named request header.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "1-based page number, used together with \"pageSize\". Defaults to the first page. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Number of items per page, used together with \"page\". Too high values will be capped. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of items to skip, used together with \"take\" as an alternative to \"page\"/\"pageSize\". May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "take", "in": "query", "description": "Number of items to return, used together with \"skip\" as an alternative to \"page\"/\"pageSize\". Too high values will be capped. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CheckCategoryCollectionResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/classification/{classificationId}": { "get": { "tags": [ "Classification" ], "summary": "Read a classification by id", "description": "### Examples\n\nReading a classification using unique identifier\n\n```http\nGET /classification/b54b7d7534944e91a8eea68700d85825\naccept: application/hal+json\n```", "operationId": "getClassificationByClassificationId", "parameters": [ { "name": "classificationId", "in": "path", "description": "id of the classification", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClassificationResource" }, "example": { "_links": { "parent": { "href": "/classification/b54b7d7534944e91a8eea68700d85825/parent", "select-key": "parent" }, "ancestors": { "href": "/classification/b54b7d7534944e91a8eea68700d85825/ancestors", "select-key": "ancestors" }, "children": { "href": "/classification/b54b7d7534944e91a8eea68700d85825/children", "select-key": "children" }, "image": { "href": "/classification/b54b7d7534944e91a8eea68700d85825/image", "select-key": "image" }, "fields": { "href": "/classification/b54b7d7534944e91a8eea68700d85825/fields", "select-key": "fields" }, "recordpermissions": { "href": "/classification/b54b7d7534944e91a8eea68700d85825/recordpermissions", "select-key": "recordpermissions" }, "classificationtreepermissions": { "href": "/classification/b54b7d7534944e91a8eea68700d85825/classificationtreepermissions", "select-key": "classificationtreepermissions" }, "followerclassifications": { "href": "/classification/b54b7d7534944e91a8eea68700d85825/followerclassifications", "select-key": "followerclassifications" }, "modifiedby": { "href": "/user/fa286193ddbf44299d2ea2390e2a8b99", "select-key": "modifiedby" }, "createdby": { "href": "/user/fa286193ddbf44299d2ea2390e2a8b99", "select-key": "createdby" }, "self": { "href": "/classification/b54b7d7534944e91a8eea68700d85825" } }, "id": "b54b7d7534944e91a8eea68700d85825", "identifier": "Test3", "name": "Test3", "namePath": null, "sortIndex": 5, "sortOrder": "Label", "disabledInDAMUI": "true", "labels": [ { "value": "Test3", "languageId": "c2bd4f9bbb954bcb80c31e924c9c26dc" } ], "isRoot": true, "parentId": null, "hasChildren": null, "tag": null, "modifiedOn": "2016-09-20T13:07:50.893Z", "createdOn": "2016-09-20T13:07:41.133Z" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "put": { "tags": [ "Classification" ], "summary": "Edit an existing classification", "description": "### Examples\n\nImmediate propagation for classification updates.\n\nFor POST, PUT and DELETE operations on the /classification resource you can force an immediate update of the search index, or immediate propagation. To do so, add the boolean header/query-string parameter **set-immediateSearchIndexUpdate** and set it to \"true\". If you don't specify this parameter, or set it to \"false\", the change will be added to the queue of the Enterprise search synchronization process. Setting the parameter to true will immediately push the classification changes to the search index, so that this classification can immediately be found, e.g. while an ETL import is still running. This is important, for example, when importing both the child and parent classifications.", "operationId": "updateClassificationByClassificationId", "parameters": [ { "name": "classificationId", "in": "path", "description": "id of the classification", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } }, { "name": "set-immediateSearchIndexUpdate", "in": "header", "description": "When true, updates the search index immediately instead of waiting for the next scheduled update. This makes the change searchable sooner but slows down the request, since it now waits on indexing instead of returning as soon as the classification is saved.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClassificationEditCommand" }, "examples": { "edit": { "summary": "Editing a classification (full body)", "value": { "name": "Digital Images", "identifier": "digital_images", "sortIndex": 6, "sortOrder": "Label", "disabledInDAMUI": "false", "fields": { "addOrUpdate": [ { "id": "7B4E156C-0730-45D9-B904-A3CD007C02A5", "localizedValues": [ { "languageId": "C2BD4F9B-BB95-4BCB-80C3-1E924C9C26DC", "value": "All images coming from a digital source" } ] }, { "id": "AB57432B-C899-40CF-BD44-802D5201973C", "sortIndex": 1 } ], "remove": [ { "id": "1A5842C2-3204-41F9-9527-D7E2F293131E" }, { "id": "D78B9DA1-A1E2-4DBE-8E2A-8F8FA62667F5" } ] }, "registeredFields": { "addOrUpdate": [ "6A5842C2-3204-41F9-9527-D7E2F293131E" ], "remove": [ "7A5842C2-3204-41F9-9527-D7E2F293131E" ] }, "registeredFieldGroups": { "addOrUpdate": [ "8A5842C2-3204-41F9-9527-D7E2F293131E" ], "remove": [ "9A5842C2-3204-41F9-9527-D7E2F293131E" ] }, "labels": [ { "languageId": "C2BD4F9B-BB95-4BCB-80C3-1E924C9C26DC", "value": "Brands - English" }, { "languageId": "1ED74A99-84CD-4A9C-BFEB-A4D000EC3275", "value": "Brands - Dutch" } ], "followerclassifications": { "addOrUpdate": [ "21d41eb183234b0cbe7b6a9c898b1de1", "21d41eb183234b0cbe7b6a9c898b1de1" ], "remove": [ "21d41eb183234b0cbe7b6a9c898b1de1" ] } } }, "edit-attributesonly": { "summary": "Editing a classification (attributes only)", "value": { "name": "New Classification Name" } } } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "delete": { "tags": [ "Classification" ], "summary": "Delete the specified classification", "description": "### Examples\n\nDeleting a classification\n\n```http\nDELETE /classification/8735a5a3e75a4bc0a2a1a3cd0069b669\n```", "operationId": "deleteClassificationByClassificationId", "parameters": [ { "name": "classificationId", "in": "path", "description": "id of the classification", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } }, { "name": "set-immediateSearchIndexUpdate", "in": "header", "description": "May also be sent as a query-string parameter of the same name. When true, updates the search index immediately instead of waiting for the next scheduled update.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Success" }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/classification": { "get": { "tags": [ "Classification" ], "summary": "Read a classification by either using a unique field and its value or by using the name path of the classification", "description": "### Examples\n\nReading a classification using a name path\n\n```http\nGET /classification/?namePath={urlEncodedNamePath}\naccept: application/hal+json\n```", "operationId": "getClassification", "parameters": [ { "name": "fieldName", "in": "query", "description": "name of the unique field", "schema": { "type": "string" } }, { "name": "fieldValue", "in": "query", "description": "Value of the field. If a numeric field value is specified, make sure to enter this value as a Culture Invariant string.", "schema": { "type": "string" } }, { "name": "namePath", "in": "query", "description": "name path of the classification", "schema": { "type": "string" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClassificationResource" }, "example": { "_links": { "parent": { "href": "/classification/28d96d5c7c8b41bcb8f4a68800b82adc/parent", "select-key": "parent" }, "ancestors": { "href": "/classification/28d96d5c7c8b41bcb8f4a68800b82adc/ancestors", "select-key": "ancestors" }, "children": { "href": "/classification/28d96d5c7c8b41bcb8f4a68800b82adc/children", "select-key": "children" }, "image": { "href": "/classification/28d96d5c7c8b41bcb8f4a68800b82adc/image", "select-key": "image" }, "fields": { "href": "/classification/28d96d5c7c8b41bcb8f4a68800b82adc/fields", "select-key": "fields" }, "recordpermissions": { "href": "/classification/28d96d5c7c8b41bcb8f4a68800b82adc/recordpermissions", "select-key": "recordpermissions" }, "classificationtreepermissions": { "href": "/classification/28d96d5c7c8b41bcb8f4a68800b82adc/classificationtreepermissions", "select-key": "classificationtreepermissions" }, "followerclassifications": { "href": "/classification/28d96d5c7c8b41bcb8f4a68800b82adc/followerclassifications", "select-key": "followerclassifications" }, "modifiedby": { "href": "/user/fa286193ddbf44299d2ea2390e2a8b99", "select-key": "modifiedby" }, "createdby": { "href": "/user/fa286193ddbf44299d2ea2390e2a8b99", "select-key": "createdby" }, "self": { "href": "/classification/28d96d5c7c8b41bcb8f4a68800b82adc" } }, "id": "28d96d5c7c8b41bcb8f4a68800b82adc", "identifier": "Test4", "name": "Test4", "namePath": null, "sortIndex": 6, "sortOrder": "Label", "disabledInDAMUI": "true", "labels": [ { "value": "Test4", "languageId": "c2bd4f9bbb954bcb80c31e924c9c26dc" } ], "isRoot": true, "parentId": null, "hasChildren": null, "tag": null, "modifiedOn": "2016-09-21T11:10:59.757Z", "createdOn": "2016-09-21T11:10:31.983Z" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/classifications": { "get": { "tags": [ "Classification" ], "summary": "Read a collection of classifications", "description": "### Examples\n\nSearching for classifications (HTTP headers)\n\n```http\nGET /classifications\naccept: application/hal+json\nfilter: ModifiedOn in today\nsort: createdon\npage: 1\npageSize: 20\n```\n\nSearching for classifications (query string parameters)\n\n```http\nGET /classifications?filter=ModifiedOn+in+today&sort=createdon&page=1&pagesize=10\n```\n\nSearching for classifications (headers + query string combined)\n\n```http\nGET /classifications?filter=ModifiedOn+in+today&sort=createdon\npage: 1\npageSize: 20\n```", "operationId": "getClassifications", "parameters": [ { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "A filter expression restricting which items are returned, e.g. \"ModifiedOn in today\". Omit to return all items the caller may see. The query parameter is the canonical location for this filter; the same value may alternatively be sent as a same-named request header.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "The property to sort by, optionally suffixed to control direction, e.g. \"createdOn\". Omit for the endpoint's default order. May also be sent as a same-named request header.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "1-based page number, used together with \"pageSize\". Defaults to the first page. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Number of items per page, used together with \"page\". Too high values will be capped. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of items to skip, used together with \"take\" as an alternative to \"page\"/\"pageSize\". May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "take", "in": "query", "description": "Number of items to return, used together with \"skip\" as an alternative to \"page\"/\"pageSize\". Too high values will be capped. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ClassificationResource" } }, "page": { "type": [ "null", "integer" ] }, "pageSize": { "type": [ "null", "integer" ] }, "totalCount": { "type": "integer", "format": "int64" } }, "description": "A paged/collection response envelope." } }, "application/hal+json": { "schema": { "required": [ "_links" ], "type": "object", "properties": { "_links": { "type": "object", "properties": { "self": { "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ClassificationResource" } }, "page": { "type": [ "null", "integer" ] }, "pageSize": { "type": [ "null", "integer" ] }, "totalCount": { "type": "integer", "format": "int64" } }, "description": "A paged/collection response envelope." } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "post": { "tags": [ "Classification" ], "summary": "Create a new classification", "description": "Create a new classification. In order to successfully create a classification, the parent of the classification must be specified via the parentId, parentName or isRoot property.", "operationId": "createClassifications", "parameters": [ { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } }, { "name": "set-immediateSearchIndexUpdate", "in": "header", "description": "When true, updates the search index immediately instead of waiting for the next scheduled update. This makes the change searchable sooner but slows down the request, since it now waits on indexing instead of returning as soon as the classification is saved.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClassificationCreateCommand" }, "example": { "parentNamePath": "/StoreInfo/Europe", "name": "Brand Related", "identifier": "brand_related", "sortIndex": 6, "sortOrder": "Label", "disabledInDAMUI": "false", "fields": { "addOrUpdate": [ { "id": "7b4e156c-0730-45d9-b904-a3cd007c02a5", "localizedValues": [ { "languageId": "C2BD4F9B-BB95-4BCB-80C3-1E924C9C26DC", "value": "description - en" } ] } ] }, "registeredFieldGroups": { "addOrUpdate": [ "34DFBAA2-98A3-4480-A9B2-2AD582304E0B" ] }, "registeredFields": { "addOrUpdate": [ "24DFBAA2-98A3-4480-A9B2-2AD582304E0B" ] }, "labels": [ { "languageId": "C2BD4F9B-BB95-4BCB-80C3-1E924C9C26DC", "value": "Brands - English" }, { "languageId": "1ED74A99-84CD-4A9C-BFEB-A4D000EC3275", "value": "Brands - Dutch" } ], "followerclassifications": { "addOrUpdate": [ "21d41eb183234b0cbe7b6a9c898b1de1", "21d41eb183234b0cbe7b6a9c898b1de1" ] } } } }, "required": true }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatedResourceId" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/classification/{classificationId}/ancestors": { "get": { "tags": [ "Classification" ], "summary": "Read all the parents of a classification", "operationId": "getClassificationAncestorsByClassificationId", "parameters": [ { "name": "classificationId", "in": "path", "description": "id of the classification", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "$ref": "#/components/mediaTypes/LinkedClassificationCollectionResourceJson" }, "application/hal+json": { "$ref": "#/components/mediaTypes/LinkedClassificationCollectionResourceHal" } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/classification/{classificationId}/children": { "get": { "tags": [ "Classification" ], "summary": "Read all the children of a classification", "operationId": "getClassificationChildrenByClassificationId", "parameters": [ { "name": "classificationId", "in": "path", "description": "id of the classification", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "$ref": "#/components/mediaTypes/ClassificationCollectionResourceJson" }, "application/hal+json": { "$ref": "#/components/mediaTypes/ClassificationCollectionResourceHal" } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/classification/{classificationId}/classificationtreepermission": { "get": { "tags": [ "Classification" ], "summary": "Read all the permissions on a classification", "operationId": "getClassificationClassificationtreepermissionByClassificationId", "parameters": [ { "name": "classificationId", "in": "path", "description": "id of the classification", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClassificationUserPermissionsResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/classification/{classificationId}/classificationtreepermissions": { "get": { "tags": [ "Classification" ], "summary": "Read the classification tree permissions of a classification", "operationId": "getClassificationClassificationtreepermissionsByClassificationId", "parameters": [ { "name": "classificationId", "in": "path", "description": "id of the classification", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClassificationPermissionsResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "put": { "tags": [ "Classification" ], "summary": "Set the classification tree permissions of a classification", "operationId": "updateClassificationClassificationtreepermissionsByClassificationId", "parameters": [ { "name": "classificationId", "in": "path", "description": "id of the classification", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClassificationPermissionsEditCommand" } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/classification/{classificationId}/downloadpermissions": { "get": { "tags": [ "Classification" ], "summary": "Read the download permissions of the classification", "operationId": "getClassificationDownloadpermissionsByClassificationId", "parameters": [ { "name": "classificationId", "in": "path", "description": "id of the classification", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClassificationDownloadPermissionsResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "put": { "tags": [ "Classification" ], "summary": "Set the download permissions of a classification", "operationId": "updateClassificationDownloadpermissionsByClassificationId", "parameters": [ { "name": "classificationId", "in": "path", "description": "id of the classification", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClassificationDownloadPermissionsEditCommand" } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/classification/{classificationId}/fields": { "get": { "tags": [ "Classification" ], "summary": "Read all fields of a classification", "operationId": "getClassificationFieldsByClassificationId", "parameters": [ { "name": "classificationId", "in": "path", "description": "id of the classification", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "$ref": "#/components/mediaTypes/FieldCollectionResourceJson" }, "application/hal+json": { "$ref": "#/components/mediaTypes/FieldCollectionResourceHal" } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/classification/{classificationId}/followerclassifications": { "get": { "tags": [ "Classification" ], "summary": "Read the list of follower classifications for the classification", "operationId": "getClassificationFollowerclassificationsByClassificationId", "parameters": [ { "name": "classificationId", "in": "path", "description": "id of the classification", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "$ref": "#/components/mediaTypes/ClassificationCollectionResourceJson" }, "application/hal+json": { "$ref": "#/components/mediaTypes/ClassificationCollectionResourceHal" } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/classification/{classificationId}/image": { "get": { "tags": [ "Classification" ], "summary": "Read the image of a classification", "operationId": "getClassificationImageByClassificationId", "parameters": [ { "name": "classificationId", "in": "path", "description": "id of the classification", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImageResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/classification/{classificationId}/parent": { "get": { "tags": [ "Classification" ], "summary": "Read the parent of a classification", "operationId": "getClassificationParentByClassificationId", "parameters": [ { "name": "classificationId", "in": "path", "description": "id of the classification", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClassificationResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/classification/{classificationId}/recordpermissions": { "get": { "tags": [ "Classification" ], "summary": "Read the record permissions of a classification", "operationId": "getClassificationRecordpermissionsByClassificationId", "parameters": [ { "name": "classificationId", "in": "path", "description": "id of the classification", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClassificationPermissionsResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "put": { "tags": [ "Classification" ], "summary": "Set the record permissions of a classification", "description": "### Examples\n\nEditing record or classification tree permissions on a classification\n\nEditing download permissions on a classification\n\n```http\nPUT /classification/8735a5a3e75a4bc0a2a1a3cd0069b669/{recordpermissions|classificationtreepermissions}\n{\n\t\"breakInheritance\":false,\n\t\"permissions\": {\n\t\t\"addOrUpdate\": [\n\t\t\t{\n\t\t\t\t\t\"userGroupId\":\"21d41eb183234b0cbe7b6a9c898b1de1\",\n\t\t\t\t\t\"accessRight\":\"Read\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\t\"userGroupId\":\"21d41eb183234b0cbe7b6a9c898b1de1\",\n\t\t\t\t\t\"accessRight\":\"FullControl\"\n\t\t\t}\n\t\t],\n\t\t\"remove\": [\n\t\t\t{\n\t\t\t\t\t\"userGroupId\":\"21d41eb183234b0cbe7b6a9c898b1de1\"\n\t\t\t}\n\t\t]\n\t}\n}\n```\n\n```http\nPUT /classification/8735a5a3e75a4bc0a2a1a3cd0069b669/downloadpermissions\n{\n\t\"breakInheritance\":false,\n\t\"permissions\": {\n\t\t\"addOrUpdate\": [\n\t\t\t{\n\t\t\t\t\t\"userGroupId\":\"e688500cc109488f959da82b0093014a\",\n\t\t\t\t\t\"accessRight\":\"Allow\"\n\t\t\t}\n\t\t],\n\t\t\"remove\": [\n\t\t\t{\n\t\t\t\t\t\"userGroupId\": \"0cb08fb798d74d369e75e017350f8378\"\n\t\t\t}\n\t\t]\n\t}\n}\n```\n\nFollower Classifications\n\n```http\nGET /classification/id\nselect-classification: FollowerClassifications\n```\n\n```http\nPUT /classification/8735a5a3e75a4bc0a2a1a3cd0069b669\n{\n\t\"followerclassifications\": {\n\t\t\"addOrUpdate\": [ \"ae82e88999d8479ab48ca3cd0069b4ba\" ],\n\t\t\"remove\": [ \"ae82e88999d8479ab48ca3cd0069b4ba\" ]\n\t}\n}\n```\n\nReading a user's classification tree permissions\n\n```http\nGET /classification/8735a5a3e75a4bc0a2a1a3cd0069b669/classificationtreepermission\n```\n\n```json\n{\n\t\"canRead\": true,\n\t\"canClassify\": true,\n\t\"canModify\": false,\n\t\"canDelete\": false\n}\n```", "operationId": "updateClassificationRecordpermissionsByClassificationId", "parameters": [ { "name": "classificationId", "in": "path", "description": "id of the classification", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClassificationPermissionsEditCommand" } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/classification/{classificationId}/field/{fieldId}": { "get": { "tags": [ "Classification" ], "summary": "Read a field of a classification", "operationId": "getClassificationFieldByClassificationIdAndFieldId", "parameters": [ { "name": "classificationId", "in": "path", "description": "id of the classification", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "fieldId", "in": "path", "description": "id of the field", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/SingleLineTextFieldResource" }, { "$ref": "#/components/schemas/MultiLineTextFieldResource" }, { "$ref": "#/components/schemas/NumericFieldResource" }, { "$ref": "#/components/schemas/DateTimeFieldResource" }, { "$ref": "#/components/schemas/DateFieldResource" }, { "$ref": "#/components/schemas/TimeFieldResource" }, { "$ref": "#/components/schemas/OptionListFieldResource" }, { "$ref": "#/components/schemas/DurationFieldResource" }, { "$ref": "#/components/schemas/UserListFieldResource" }, { "$ref": "#/components/schemas/UserGroupListFieldResource" }, { "$ref": "#/components/schemas/HtmlFieldResource" }, { "$ref": "#/components/schemas/JsonFieldResource" }, { "$ref": "#/components/schemas/ClassificationListFieldResource" }, { "$ref": "#/components/schemas/RecordListFieldResource" }, { "$ref": "#/components/schemas/RecordLinkFieldResource" }, { "$ref": "#/components/schemas/LanguageListFieldResource" }, { "$ref": "#/components/schemas/TextListFieldResource" }, { "$ref": "#/components/schemas/HyperlinkListFieldResource" } ], "discriminator": { "propertyName": "dataType", "mapping": { "SingleLineText": "#/components/schemas/SingleLineTextFieldResource", "MultiLineText": "#/components/schemas/MultiLineTextFieldResource", "Numeric": "#/components/schemas/NumericFieldResource", "DateTime": "#/components/schemas/DateTimeFieldResource", "Date": "#/components/schemas/DateFieldResource", "Time": "#/components/schemas/TimeFieldResource", "OptionList": "#/components/schemas/OptionListFieldResource", "Duration": "#/components/schemas/DurationFieldResource", "UserList": "#/components/schemas/UserListFieldResource", "UserGroupList": "#/components/schemas/UserGroupListFieldResource", "Html": "#/components/schemas/HtmlFieldResource", "Json": "#/components/schemas/JsonFieldResource", "ClassificationList": "#/components/schemas/ClassificationListFieldResource", "RecordList": "#/components/schemas/RecordListFieldResource", "RecordLink": "#/components/schemas/RecordLinkFieldResource", "LanguageList": "#/components/schemas/LanguageListFieldResource", "TextList": "#/components/schemas/TextListFieldResource", "HyperlinkList": "#/components/schemas/HyperlinkListFieldResource" } } } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/collection/{collectionId}": { "get": { "tags": [ "Collection" ], "summary": "Read a collection", "description": "### Examples\n\nReading a collection using guid\n\n```http\nGET /collection/f93aad563b034777b7daa842008d4f99\n```", "operationId": "getCollectionByCollectionId", "parameters": [ { "name": "collectionId", "in": "path", "description": "id of the collection", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollectionResource" }, "example": { "_links": { "ownedby": { "href": "/user/fa286193ddbf44299d2ea2390e2a8b99", "select-key": "ownedby" }, "permissions": { "href": "/collection/f93aad563b034777b7daa842008d4f99/permissions", "select-key": "permissions" }, "records": { "href": "/collection/f93aad563b034777b7daa842008d4f99/records", "select-key": "records" }, "modifiedby": { "href": "/user/fa286193ddbf44299d2ea2390e2a8b99", "select-key": "modifiedby" }, "createdby": { "href": "/user/fa286193ddbf44299d2ea2390e2a8b99", "select-key": "createdby" }, "self": { "href": "/collection/f93aad563b034777b7daa842008d4f99" } }, "id": "f93aad563b034777b7daa842008d4f99", "name": "Collection name", "type": "static", "status": "Active", "ownerId": "fa286193ddbf44299d2ea2390e2a8b99", "tag": null, "isReadOnly": null, "modifiedOn": "2017-12-07T08:34:29.84Z", "createdOn": "2017-12-07T08:34:29.84Z" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "put": { "tags": [ "Collection" ], "summary": "Edit an existing collection", "description": "### Examples\n\nEditing an existing collection\n\nOptional status may be Active or Archived to change lifecycle state. Omit status to leave it unchanged. To remove a collection, use DELETE (not status).\n\nWhen editing a dynamic collection, you can also change the search expression of the collection.\n\n```http\nPUT /collection/f93aad563b034777b7daa842008d4f99\n{\n \"name\" : \"New name for the collection\",\n \"searchExpression\" : {\n \"expression\" : \"Classification.Name = 'MyClass'\",\n \"languages\" : [\n \"c2bd4f9bbb954bcb80c31e924c9c26dc\"\n ]\n },\n \"tag\" : \"new content\"\n}\n```", "operationId": "updateCollectionByCollectionId", "parameters": [ { "name": "collectionId", "in": "path", "description": "id of the collection", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollectionEditCommandBase" }, "example": { "name": "New name for the collection", "description": "New description for the collection", "tag": "new content", "status": "Archived" } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "delete": { "tags": [ "Collection" ], "summary": "Delete the specified collection", "description": "### Examples\n\nDeleting a collection\n\n```http\nDELETE /collection/f93aad563b034777b7daa842008d4f99\n```", "operationId": "deleteCollectionByCollectionId", "parameters": [ { "name": "collectionId", "in": "path", "description": "id of the collection", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/collections": { "get": { "tags": [ "Collection" ], "summary": "Read a collection of collections", "description": "### Examples\n\nSearching for collections (HTTP headers)\n\n```http\nGET /collections\nfilter: ModifiedOn in today\nsort: createdon\npage: 1\npageSize: 20\n```\n\nSearching for collections (query string parameters)\n\n```http\nGET /collections?filter=ModifiedOn+in+today&sort=createdon&page=1&pagesize=10\n```\n\nSearching for collections (headers + query string combined)\n\n```http\nGET /collections?filter=ModifiedOn+in+today&sort=createdon\npage: 1\npageSize: 20\n```", "operationId": "getCollections", "parameters": [ { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "A filter expression restricting which items are returned, e.g. \"ModifiedOn in today\". Omit to return all items the caller may see. The query parameter is the canonical location for this filter; the same value may alternatively be sent as a same-named request header.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "The property to sort by, optionally suffixed to control direction, e.g. \"createdOn\". Omit for the endpoint's default order. May also be sent as a same-named request header.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "1-based page number, used together with \"pageSize\". Defaults to the first page. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Number of items per page, used together with \"page\". Too high values will be capped. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of items to skip, used together with \"take\" as an alternative to \"page\"/\"pageSize\". May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "take", "in": "query", "description": "Number of items to return, used together with \"skip\" as an alternative to \"page\"/\"pageSize\". Too high values will be capped. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CollectionResource" } }, "page": { "type": [ "null", "integer" ] }, "pageSize": { "type": [ "null", "integer" ] }, "totalCount": { "type": "integer", "format": "int64" } }, "description": "A paged/collection response envelope." } }, "application/hal+json": { "schema": { "required": [ "_links" ], "type": "object", "properties": { "_links": { "type": "object", "properties": { "self": { "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/CollectionResource" } }, "page": { "type": [ "null", "integer" ] }, "pageSize": { "type": [ "null", "integer" ] }, "totalCount": { "type": "integer", "format": "int64" } }, "description": "A paged/collection response envelope." } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "post": { "tags": [ "Collection" ], "summary": "Create a new collection", "operationId": "createCollections", "parameters": [ { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollectionCreateCommandBase" }, "examples": { "create": { "summary": "Creating a new static collection.", "value": { "name": "New Collection", "description": "Description for the collection", "type": "static", "tag": "", "allowAutoAccess": false } }, "createdynamic": { "summary": "Creating a new dynamic collection.", "value": { "name": "New Collection", "type": "dynamic", "searchExpression": { "expression": "Classification.Name = 'MyClass'", "languages": [ "c2bd4f9bbb954bcb80c31e924c9c26dc" ] }, "tag": "" } }, "createdynamicsubexpressions": { "summary": "Creating a new dynamic collection with subexpressions.", "value": { "name": "New Collection", "type": "dynamic", "searchExpression": { "subExpressions": [ { "expression": "filecount >= 1", "languages": [ "c2bd4f9bbb954bcb80c31e924c9c26dc" ] }, { "expression": "Classification.Name = 'MyClass'", "languages": [ "c2bd4f9bbb954bcb80c31e924c9c26dc" ] } ] }, "tag": "" } } } } }, "required": true }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatedResourceId" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/collections/search": { "post": { "tags": [ "Collection" ], "summary": "Search collections with the parameters in the request body", "description": "Search collections with the parameters in the request body. Functionally equivalent to GET, but the filter travels in the body so it is not subject to header or query-string size limits.", "operationId": "createCollectionsSearch", "parameters": [ { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollectionSearchBodyResource" }, "example": { "filter": "NOT (Id in '\"b59646bd-99cb-41b0-891a-b4050086ab93\",\"a85d52b7-e97e-4783-aed7-b456009ea811\"')", "sort": "Name", "skip": 0, "take": 20, "includeArchived": false } } }, "required": true }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CollectionResource" } }, "page": { "type": [ "null", "integer" ] }, "pageSize": { "type": [ "null", "integer" ] }, "totalCount": { "type": "integer", "format": "int64" } }, "description": "A paged/collection response envelope." } }, "application/hal+json": { "schema": { "required": [ "_links" ], "type": "object", "properties": { "_links": { "type": "object", "properties": { "self": { "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/CollectionResource" } }, "page": { "type": [ "null", "integer" ] }, "pageSize": { "type": [ "null", "integer" ] }, "totalCount": { "type": "integer", "format": "int64" } }, "description": "A paged/collection response envelope." } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/collection/{collectionId}/comments": { "get": { "tags": [ "Collection" ], "summary": "Read the comments of the collection", "operationId": "getCollectionCommentsByCollectionId", "parameters": [ { "name": "collectionId", "in": "path", "description": "id of the collection", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "The property to sort by, optionally suffixed to control direction, e.g. \"createdOn\". Omit for the endpoint's default order. May also be sent as a same-named request header.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "1-based page number, used together with \"pageSize\". Defaults to the first page. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Number of items per page, used together with \"page\". Too high values will be capped. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of items to skip, used together with \"take\" as an alternative to \"page\"/\"pageSize\". May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "take", "in": "query", "description": "Number of items to return, used together with \"skip\" as an alternative to \"page\"/\"pageSize\". Too high values will be capped. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "$ref": "#/components/mediaTypes/IPagedCollectionResourceOfCommentResourceJson" }, "application/hal+json": { "$ref": "#/components/mediaTypes/IPagedCollectionResourceOfCommentResourceHal" } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "post": { "tags": [ "Collection" ], "summary": "Create a new comment on a collection", "operationId": "createCollectionCommentsByCollectionId", "parameters": [ { "name": "collectionId", "in": "path", "description": "id of the collection", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollectionCommentCreateCommand" }, "example": { "message": "Hello world" } } }, "required": true }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatedResourceId" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/collection/{collectionId}/permissions": { "get": { "tags": [ "Collection" ], "summary": "Read the permissions of the collection", "description": "### Examples\n\nReading collection's permissions\n\nTo change these, see PUT /collection/{collectionId}/permissions.\n\n```http\nGET /collection/f93aad563b034777b7daa842008d4f99/permissions\n```", "operationId": "getCollectionPermissionsByCollectionId", "parameters": [ { "name": "collectionId", "in": "path", "description": "id of the collection", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollectionPermissionsResource" }, "example": { "_links": { "permissions": { "href": "/collection/f93aad563b034777b7daa842008d4f99/permissions" } }, "permissions": [ { "userId": "fa286193ddbf44299d2ea2390e2a8b99", "permission": "Modify" }, { "userId": "98c01138110445281215afb8cd61d3bc", "permission": "Read" } ], "groupsPermissions": [ { "groupId": "00db70f92fd2417cb898337b7a26641a", "permission": "Modify" }, { "groupId": "98c01138110445281215afb8cd61d3bc", "permission": "Read" } ], "publicPermission": "None", "canRead": true, "canModify": true, "contentPermission": { "contentSharingEnabled": true, "contentSharingExpiryDate": "2024-08-30T08:55:00Z", "permission": "read" } } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "put": { "tags": [ "Collection" ], "summary": "Set the permissions of the collection", "operationId": "updateCollectionPermissionsByCollectionId", "parameters": [ { "name": "collectionId", "in": "path", "description": "id of the collection", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollectionPermissionsEditCommand" }, "example": { "permissions": { "addOrUpdate": [ { "userId": "32186193ddbf44200d2ea2390e2a8b00", "permission": "Read" } ], "remove": [ { "userId": "127fa1524e43497fb6d7a83c00efb7f7" } ] }, "groupsPermissions": { "addOrUpdate": [ { "groupId": "f93aad563b034777b7daa842008d4f99", "permission": "Modify" } ], "remove": [ { "groupId": "127fa1524e43497fb6d7a83c00efb7f7" } ] }, "publicPermission": "None", "contentPermission": { "contentSharingEnabled": true, "contentSharingExpiryDate": "2025-08-30T08:55:00Z", "permission": "read" } } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/collection/{collectionId}/records": { "get": { "tags": [ "Collection" ], "summary": "Read the records of the collection", "description": "### Examples\n\nReading a collection's records\n\nNote: this is not supported for dynamic collections. To read the records of a dynamic collection, you should use the record search expression \"Collection(collectionId)\".\n\nTo change these, see PUT /collection/{collectionId}/records.\n\n```http\nGET /collection/f93aad563b034777b7daa842008d4f99/records\n```", "operationId": "getCollectionRecordsByCollectionId", "parameters": [ { "name": "collectionId", "in": "path", "description": "id of the collection", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "title": "Record collection resource", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/RecordResource" }, "description": "A collection of resource items." } }, "description": "Representation of a non-paged collection of records" }, "example": { "_links": { "records": { "href": "http://localhost:2015/collection/f93aad563b034777b7daa842008d4f99/records" } }, "items": [ { "_links": { "fields": { "href": "http://localhost:2015/record/127fa1524e43497fb6d7a83c00efb7f7/fields", "select-key": "fields" }, "files": { "href": "http://localhost:2015/record/127fa1524e43497fb6d7a83c00efb7f7/files", "select-key": "files" }, "preview": { "href": "http://localhost:2015/record/127fa1524e43497fb6d7a83c00efb7f7/image/preview", "select-key": "preview" }, "thumbnail": { "href": "http://localhost:2015/record/127fa1524e43497fb6d7a83c00efb7f7/image/thumbnail", "select-key": "thumbnail" }, "masterfile": { "href": "http://localhost:2015/record/127fa1524e43497fb6d7a83c00efb7f7/masterfile", "select-key": "masterfile" }, "masterfilelatestversion": { "href": "http://localhost:2015/record/127fa1524e43497fb6d7a83c00efb7f7/masterfilelatestversion", "select-key": "masterfilelatestversion" }, "classifications": { "href": "http://localhost:2015/record/127fa1524e43497fb6d7a83c00efb7f7/classifications", "select-key": "classifications" }, "parent": { "href": "http://localhost:2015/record/127fa1524e43497fb6d7a83c00efb7f7/parent", "select-key": "parent" }, "ancestors": { "href": "http://localhost:2015/record/127fa1524e43497fb6d7a83c00efb7f7/ancestors", "select-key": "ancestors" }, "children": { "href": "http://localhost:2015/record/127fa1524e43497fb6d7a83c00efb7f7/children", "select-key": "children" }, "modifiedby": { "href": "http://localhost:2015/user/98c01138110445281215afb8cd61d3bc", "select-key": "modifiedby" }, "createdby": { "href": "http://localhost:2015/user/98c01138110445281215afb8cd61d3bc", "select-key": "createdby" }, "self": { "href": "http://localhost:2015/record/127fa1524e43497fb6d7a83c00efb7f7" } }, "id": "127fa1524e43497fb6d7a83c00efb7f7", "contentType": "Record", "tag": null, "modifiedOn": "2017-12-01T14:32:51.7Z", "createdOn": "2017-12-01T14:32:47.327Z" } ] } }, "application/hal+json": { "schema": { "required": [ "_links" ], "$ref": "#/components/schemas/RecordCollectionResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "put": { "tags": [ "Collection" ], "summary": "Set the records of the collection", "operationId": "updateCollectionRecordsByCollectionId", "parameters": [ { "name": "collectionId", "in": "path", "description": "id of the collection", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollectionRecordsEditCommand" }, "example": { "records": { "addOrUpdate": [ "daffa1524e43497fb6d7a83c123457dd" ], "remove": [ "127fa1524e43497fb6d7a83c00efb7f7" ] } } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/collection/{collectionId}/comment/{commentId}": { "get": { "tags": [ "Collection" ], "summary": "Read a comment on the collection", "operationId": "getCollectionCommentByCollectionIdAndCommentId", "parameters": [ { "name": "collectionId", "in": "path", "description": "id of the collection", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "commentId", "in": "path", "description": "id of the comment", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommentResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "put": { "tags": [ "Collection" ], "summary": "Edit a comment on a collection", "operationId": "updateCollectionCommentByCollectionIdAndCommentId", "parameters": [ { "name": "collectionId", "in": "path", "description": "Id of the collection", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "commentId", "in": "path", "description": "Id of the comment", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollectionCommentEditCommand" }, "example": { "content": "Hello, John Doe" } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "delete": { "tags": [ "Collection" ], "summary": "Delete the specified comment from a collection", "description": "### Examples\n\nDeletes a comment from a collection\n\n```http\nDELETE /collection/f93aad563b034777b7daa842008d4f99/comment/4f247286901b4f0199fbb1e100734791\n```", "operationId": "deleteCollectionCommentByCollectionIdAndCommentId", "parameters": [ { "name": "collectionId", "in": "path", "description": "id of the collection", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "commentId", "in": "path", "description": "id of the comment", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/collection/{collectionId}/comments/status": { "get": { "tags": [ "Collection" ], "summary": "Read the count of unread comments of a collection", "operationId": "getCollectionCommentsStatusByCollectionId", "parameters": [ { "name": "collectionId", "in": "path", "description": "Id of the collection", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommentsStatusResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "put": { "tags": [ "Collection" ], "summary": "Mark the comments as read", "operationId": "updateCollectionCommentsStatusByCollectionId", "parameters": [ { "name": "collectionId", "in": "path", "description": "Id of the collection", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarkCommentsAsReadCommand" }, "example": { "id": "4f247286901b4f0199fbb1e100734791", "lastReadCommentDate": "2024-12-07T08:34:29.84Z" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommentsStatusResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/collection/{collectionId}/permissions/autoReadAccess": { "put": { "tags": [ "Collection" ], "summary": "Grant Read access to the specified users on the collection", "description": "Grant Read access to the specified users on the collection. Requires both the EnableAutoAccessCollection feature flag and the collection's allowAutoAccess setting to be enabled.", "operationId": "updateCollectionPermissionsAutoReadAccessByCollectionId", "parameters": [ { "name": "collectionId", "in": "path", "description": "id of the collection", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollectionPermissionsAutoReadAccessCommand" }, "example": { "userIds": [ "32186193ddbf44200d2ea2390e2a8b00" ] } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollectionPermissionsAutoReadAccessResource" }, "example": { "autoAccessEnabled": true, "grantedUserIds": [ "32186193ddbf44200d2ea2390e2a8b00" ], "skippedUserIds": [ ] } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/contenttype/{contentTypeId}": { "get": { "tags": [ "Content type" ], "summary": "Read a content type", "description": "### Examples\n\nReading a content type with embedded resources\n\nWhen reading a content type you can specify the 'accept' header value **hal+json**. All subresources are represented as links to those resources.\n\n```http\nGET /contenttype/271ee18ad0884ecebfc3a3cd0069d759\naccept: application/hal+json\n```", "operationId": "getContenttypeByContentTypeId", "parameters": [ { "name": "contentTypeId", "in": "path", "description": "id of the content type", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentTypeResource" }, "example": { "_links": { "parent": { "href": "/contenttype/7dacae02724d4817a281333eb3df7bc9/parent", "select-key": "parent" } }, "id": "7dacae02724d4817a281333eb3df7bc9", "name": "Video", "purpose": "This is the default content type for managing video content.", "parentId": null, "isManual": false, "registeredFields": [ { "fieldId": "6e9807ce16bd4960bda1b26327633896" }, { "fieldId": "3cf7281e787d43369827990388017911" } ], "labels": [ { "value": "Video", "languageId": "c2bd4f9bbb954bcb80c31e924c9c26dc" } ], "defaultFileExtensions": [ "AVI", "MP4" ], "titleConfiguration": { "option": "Field", "fieldId": "355108addf4c49a9a718ab7a00ca2792" }, "inheritanceConfiguration": "Custom", "inheritanceFieldId": "b44b8f2d64b04f1ab150acd100ea640a", "inheritableFields": [ { "fieldId": "0998866684224253816eacd100ea3dc4" }, { "fieldId": "64ee218414da428bbb1dacd200d37010" } ], "fileMode": "CreateFromUrl", "fileConfiguration": { "urlFieldId": "8ea636ad4dcb49c599eeae6200aaa627", "crawlLevelOption": "Fixed", "maximumNumberOfPages": 100, "crawlLevelValue": 3, "crawlLevelFieldId": "34d75a3ea0d54482aa94ae5c00c85718" }, "registeredFieldGroups": [ { "fieldGroupId": "6e9807ce16bd4960bda1b26327633896" }, { "fieldGroupId": "3cf7281e787d43369827990388017911" } ], "modifiedOn": "2019-12-17T10:27:03.4076939+01:00", "createdOn": "2019-12-17T10:27:03.4076939+01:00" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "put": { "tags": [ "Content type" ], "summary": "Edit an existing content type", "operationId": "updateContenttypeByContentTypeId", "parameters": [ { "name": "contentTypeId", "in": "path", "description": "id of the content type", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentTypeEditCommand" }, "example": { "name": "Images", "purpose": "Content type for images.", "parentId": "7dacae02724d4817a281333eb3df7bc9", "isNoFile": true, "registeredFields": { "addOrUpdate": [ "f0558ea6ffe5453698ae35bc4c242e9a", "bc98956b9f044216a5c797fdb65b130e" ], "remove": [ "5a8dc47449c34fe282bdfcf268d47dd1" ] }, "labels": [ { "languageId": "C2BD4F9B-BB95-4BCB-80C3-1E924C9C26DC", "value": "Image" }, { "languageId": "1ED74A99-84CD-4A9C-BFEB-A4D000EC3275", "value": "Afbeelding" } ], "defaultFileExtensions": { "addOrUpdate": [ "JPG", "JPEG", "TIFF" ], "remove": [ "BMP" ] }, "titleConfiguration": { "option": "Field", "fieldId": "355108addf4c49a9a718ab7a00ca2792" }, "inheritanceConfiguration": "Custom", "inheritanceFieldId": "b44b8f2d64b04f1ab150acd100ea640a", "inheritableFields": { "addOrUpdate": [ "f0558ea6ffe5453698ae35bc4c242e9a", "bc98956b9f044216a5c797fdb65b130e" ], "remove": [ "5a8dc47449c34fe282bdfcf268d47dd1" ] }, "fileMode": "CreateFromUrl", "fileConfiguration": { "urlFieldId": "8ea636ad4dcb49c599eeae6200aaa627", "crawlLevelOption": "Fixed", "maximumNumberOfPages": 100, "crawlLevelValue": 3, "crawlLevelFieldId": "34d75a3ea0d54482aa94ae5c00c85718" }, "registeredFieldGroups": { "addOrUpdate": [ "f0558ea6ffe5453698ae35bc4c242e9a", "bc98956b9f044216a5c797fdb65b130e" ], "remove": [ "5a8dc47449c34fe282bdfcf268d47dd1" ] } } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "delete": { "tags": [ "Content type" ], "summary": "Delete the specified content type", "description": "### Examples\n\nDeleting a content type\n\nDeleting a content type is only allowed when no records exist of that type. Also, you cannot delete a predefined content type like 'Video'.\n\n```http\nDELETE /contenttype/31072990f5ec458a9145a7f9008c1404\n```", "operationId": "deleteContenttypeByContentTypeId", "parameters": [ { "name": "contentTypeId", "in": "path", "description": "id of the content type", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/ContentType": { "get": { "tags": [ "Content type" ], "summary": "Read a content type by name", "description": "### Examples\n\nReading a content type by name or by unique identifier\n\n```http\nGET /contenttype/?name={urlEncodedName}\naccept: application/json\n```\n\n```http\nGET /contenttype/7dacae02724d4817a281333eb3df7bc9\naccept: application/json\n```", "operationId": "getContentType", "parameters": [ { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentTypeResource" }, "example": { "id": "7dacae02724d4817a281333eb3df7bc9", "name": "Video", "purpose": "This is the default content type for managing video content.", "parentId": null, "parent": null, "isManual": false, "registeredFields": [ { "fieldId": "6e9807ce16bd4960bda1b26327633896" }, { "fieldId": "3cf7281e787d43369827990388017911" } ], "labels": [ { "value": "Video", "languageId": "c2bd4f9bbb954bcb80c31e924c9c26dc" } ], "defaultFileExtensions": [ "AVI", "MP4" ], "titleConfiguration": { "option": "Field", "fieldId": "355108addf4c49a9a718ab7a00ca2792" }, "inheritanceConfiguration": "Custom", "inheritanceFieldId": "b44b8f2d64b04f1ab150acd100ea640a", "inheritableFields": [ { "fieldId": "0998866684224253816eacd100ea3dc4" }, { "fieldId": "64ee218414da428bbb1dacd200d37010" } ], "fileMode": "CreateFromUrl", "fileConfiguration": { "urlFieldId": "8ea636ad4dcb49c599eeae6200aaa627", "crawlLevelOption": "Fixed", "maximumNumberOfPages": 100, "crawlLevelValue": 3, "crawlLevelFieldId": "34d75a3ea0d54482aa94ae5c00c85718" }, "registeredFieldGroups": [ { "fieldGroupId": "6e9807ce16bd4960bda1b26327633896" }, { "fieldGroupId": "3cf7281e787d43369827990388017911" } ], "modifiedOn": "2019-12-17T10:27:03.4076939+01:00", "modifiedBy": null, "createdOn": "2019-12-17T10:27:03.4076939+01:00", "createdBy": null } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/contenttypes": { "get": { "tags": [ "Content type" ], "summary": "Read a collection of content types", "description": "### Examples\n\nSearching for content types (HTTP headers)\n\n```http\nGET /contenttypes\naccept: application/hal+json\nfilter: video\npage: 1\npageSize: 20\n```\n\nSearching for content types (query string parameters)\n\n```http\nGET /contenttypes?filter=video&page=1&pagesize=10\n```", "operationId": "getContenttypes", "parameters": [ { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "A filter expression restricting which items are returned, e.g. \"ModifiedOn in today\". Omit to return all items the caller may see. The query parameter is the canonical location for this filter; the same value may alternatively be sent as a same-named request header.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "The property to sort by, optionally suffixed to control direction, e.g. \"createdOn\". Omit for the endpoint's default order. May also be sent as a same-named request header.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "1-based page number, used together with \"pageSize\". Defaults to the first page. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Number of items per page, used together with \"page\". Too high values will be capped. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of items to skip, used together with \"take\" as an alternative to \"page\"/\"pageSize\". May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "take", "in": "query", "description": "Number of items to return, used together with \"skip\" as an alternative to \"page\"/\"pageSize\". Too high values will be capped. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "title": "Content type paged collection resource", "type": "object", "properties": { "pageNumber": { "type": [ "null", "integer" ], "description": "The current page of this paged collection.", "format": "int32" }, "pageSize": { "type": [ "null", "integer" ], "description": "The current page size of this paged collection.", "format": "int32" }, "skip": { "type": [ "null", "integer" ], "description": "The current skip size of this paged collection.", "format": "int32" }, "take": { "type": [ "null", "integer" ], "description": "The current take size of this paged collection.", "format": "int32" }, "totalCount": { "type": "integer", "description": "The total count of items in this paged collection, not just on the current page.", "format": "int64" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ContentTypeResource" }, "description": "One page of this paged collection, which is a subcollection of the complete collection." } }, "description": "Representation of a paged collection of content types" } }, "application/hal+json": { "schema": { "required": [ "_links" ], "$ref": "#/components/schemas/ContentTypePagedCollectionResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "post": { "tags": [ "Content type" ], "summary": "Create a new content type", "description": "### Examples\n\nOptions for fileMode\n\nThe available options for fileMode are \"UploadFile\", \"NoFile\", \"CreateFromUrl\" and \"CreateFromSmartAgent\". The default option is \"UploadFile\". If fileMode is set to either \"NoFile\", \"CreateFromUrl\" or \"CreateFromSmartAgent\", defaultFileExtensions cannot be used. The titleConfiguration must also always use the option \"Field\". If the fileMode is not \"CreateFromUrl\" or \"CreateFromSmartAgent\", fileConfiguration can be null.\n- For fileConfiguration, crawlLevelOption can be either \"Fixed\" or \"Field\"\n- If crawlLevelOption is \"Fixed\", the crawlLevelValue field must be used and the crawlLevelFieldId field must not be used.\n- If crawlLevelOption is \"Field\", the crawlLevelFieldId field must be used and the crawlLevelValue field must not be used.", "operationId": "createContenttypes", "parameters": [ { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentTypeCreateCommand" }, "examples": { "create": { "summary": "Creating a content type", "value": { "name": "Image", "purpose": "Content type for images.", "parentId": "7dacae02724d4817a281333eb3df7bc9", "isNoFile": false, "registeredFields": { "addOrUpdate": [ "5a8dc47449c34fe282bdfcf268d47dd1", "bc98956b9f044216a5c797fdb65b130e" ] }, "labels": [ { "languageId": "C2BD4F9B-BB95-4BCB-80C3-1E924C9C26DC", "value": "Image" }, { "languageId": "1ED74A99-84CD-4A9C-BFEB-A4D000EC3275", "value": "Afbeelding" } ], "defaultFileExtensions": { "addOrUpdate": [ "JPG", "JPEG", "TIFF" ] }, "titleConfiguration": { "option": "Field", "fieldId": "355108addf4c49a9a718ab7a00ca2792" }, "inheritanceConfiguration": "Custom", "inheritanceFieldId": "b44b8f2d64b04f1ab150acd100ea640a", "inheritableFields": { "addOrUpdate": [ "0998866684224253816eacd100ea3dc4", "64ee218414da428bbb1dacd200d37010" ] }, "fileMode": "CreateFromUrl", "fileConfiguration": { "urlFieldId": "8ea636ad4dcb49c599eeae6200aaa627", "crawlLevelOption": "Fixed", "maximumNumberOfPages": 100, "crawlLevelValue": 1, "crawlLevelFieldId": "34d75a3ea0d54482aa94ae5c00c85718" }, "registeredFieldGroups": { "addOrUpdate": [ "f0558ea6ffe5453698ae35bc4c242e9a", "bc98956b9f044216a5c797fdb65b130e" ], "remove": [ "5a8dc47449c34fe282bdfcf268d47dd1" ] } } }, "field-titleconfiguration": { "summary": "Specify a title configuration using a field", "value": { "name": "Image", "purpose": "Content type for images.", "titleConfiguration": { "option": "Field", "fieldId": "355108addf4c49a9a718ab7a00ca2792" } } }, "filename-titleconfiguration": { "summary": "Specify a title configuration using the filename of the latest master file", "value": { "name": "Image", "purpose": "Content type for images.", "titleConfiguration": { "option": "FileName", "showExtension": true } } }, "fileConfiguration-fixed-crawl": { "summary": "File configuration with fixed crawl level", "value": { "name": "WebsitePDF", "fileMode": "CreateFromUrl", "fileConfiguration": { "urlFieldId": "8ea636ad4dcb49c599eeae6200aaa627", "crawlLevelOption": "Fixed", "maximumNumberOfPages": 100, "crawlLevelValue": 1 } } }, "fileConfiguration-field-crawl": { "summary": "File configuration with field-based crawl level", "value": { "name": "WebsitePDF", "fileMode": "CreateFromUrl", "fileConfiguration": { "urlFieldId": "8ea636ad4dcb49c599eeae6200aaa627", "crawlLevelOption": "Field", "maximumNumberOfPages": 100, "crawlLevelFieldId": "34d75a3ea0d54482aa94ae5c00c85718" } } } } } }, "required": true }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentTypeCreatedResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/contenttypes/info": { "get": { "tags": [ "Content type" ], "summary": "Read a collection of content types basic info", "description": "### Examples\n\nList only content type basic info\n\n```http\nGET /contenttypes/info\naccept: application/json\n```", "operationId": "getContenttypesInfo", "parameters": [ { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContentTypeInfoResource" } }, "example": [ { "id": "1d793d990f8b43ab9c7905ba02f84ee7", "name": "Asset", "parentId": "5dc726d32eff446589817a9a514d5313" }, { "id": "5dc726d32eff446589817a9a514d5313", "name": "Record", "parentId": null } ] } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/contenttype/{contentTypeId}/parent": { "get": { "tags": [ "Content type" ], "summary": "Read the parent of a content type", "operationId": "getContenttypeParentByContentTypeId", "parameters": [ { "name": "contentTypeId", "in": "path", "description": "id of the content type", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentTypeResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/counter/{counterName}": { "put": { "tags": [ "Counter" ], "summary": "Edit an existing counter", "operationId": "updateCounterByCounterName", "parameters": [ { "name": "counterName", "in": "path", "description": "name of the counter", "required": true, "schema": { "type": "string" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CounterEditCommand" }, "example": { "value": "9402" } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/counters": { "get": { "tags": [ "Counter" ], "summary": "Read all counters", "operationId": "getCounters", "parameters": [ { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CounterCollectionResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/csp": { "get": { "tags": [ "CSP policy" ], "summary": "Read the Content Security Policy domains for this location", "operationId": "getCsp", "parameters": [ { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CspResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/download": { "get": { "tags": [ "Download" ], "summary": "Retrieve binary content of a file using a secure download token", "description": "Retrieve binary content of a file using a secure download token. Response headers include Content-Type, Content-Length, Content-Disposition, and Accept-Ranges.", "operationId": "getDownload", "parameters": [ { "name": "token", "in": "query", "description": "Reference token to the file", "required": true, "schema": { "type": "string" } }, { "name": "downloadAgreementContentId", "in": "query", "description": "ID of the download agreement content which was accepted before download", "schema": { "type": [ "null", "integer" ], "format": "int32" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "head": { "tags": [ "Download" ], "summary": "Retrieve binary content of a file using a secure download token", "description": "Retrieve binary content of a file using a secure download token. Response headers include Content-Type, Content-Length, Content-Disposition, and Accept-Ranges. Returns the same headers as the equivalent GET request, with no response body - use it to check availability, size, and content type without transferring the file.", "operationId": "headDownload", "parameters": [ { "name": "token", "in": "query", "description": "Reference token to the file", "required": true, "schema": { "type": "string" } }, { "name": "downloadAgreementContentId", "in": "query", "description": "ID of the download agreement content which was accepted before download", "schema": { "type": [ "null", "integer" ], "format": "int32" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/downloadagreement/{downloadAgreementId}": { "get": { "tags": [ "Download agreement" ], "summary": "Read a download agreement", "description": "### Examples\n\nSearching for a single download agreement\n\n```http\nGET /downloadagreement/1\n```", "operationId": "getDownloadagreementByDownloadAgreementId", "parameters": [ { "name": "downloadAgreementId", "in": "path", "description": "id of the download agreement", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DownloadAgreementResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "put": { "tags": [ "Download agreement" ], "summary": "Edit an existing download agreement", "operationId": "updateDownloadagreementByDownloadAgreementId", "parameters": [ { "name": "downloadAgreementId", "in": "path", "description": "id of the download agreement", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DownloadAgreementEditCommand" }, "example": { "enabled": true, "classifications": { "addOrUpdate": [ "44b9340f-18ed-4469-9ab1-b19d0091a6c2", "7baa7250-cc6f-4a06-b2b5-218afd2355e7" ], "remove": [ "e96c90ec-8555-4c48-ad45-7938f72a0797", "b09d1874-d632-49ce-ab4b-2495677bcc70" ] }, "userGroups": { "addOrUpdate": [ "301d3f2b-d952-4c1a-b017-74480f0f92d2", "502dbb18-960c-4520-bb79-7e5629b54427" ], "remove": [ "21d41eb183234b0cbe7b6a9c898b1de1", "17f67315-3a72-4736-906a-442fb477718c" ] }, "contents": { "addOrUpdate": [ { "languageId": "C2BD4F9B-BB95-4BCB-80C3-1E924C9C26DC", "title": "Download agreement title in English ", "termsOfUse": "Terms of use in English" }, { "languageId": "5EC55442-1CAC-4734-A0ED-E1D01CD1E49F", "title": "Titolo dell'accordo di download in italiano", "termsOfUse": "Termini di utilizzo in italiano" } ] } } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "delete": { "tags": [ "Download agreement" ], "summary": "Delete the specified download agreement", "description": "### Examples\n\nDeleting a download agreement\n\n```http\nDELETE /downloadagreement/1\n```", "operationId": "deleteDownloadagreementByDownloadAgreementId", "parameters": [ { "name": "downloadAgreementId", "in": "path", "description": "id of the download agreement", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/downloadAgreements": { "get": { "tags": [ "Download agreement" ], "summary": "Read a collection of download agreements", "description": "### Examples\n\nSearching for download agreements (HTTP headers)\n\n```http\nGET /downloadagreements\naccept: application/hal+json\nsort: modifiedOn\npage: 1\npageSize: 20\n```\n\nSearching for download agreements (query string parameters)\n\n```http\nGET /downloadagreements?sort=createdon&page=1&pagesize=10\n```\n\nSearching for download agreements (headers + query string combined)\n\n```http\nGET /downloadagreements?sort=createdon\npage: 1\npageSize: 20\n```", "operationId": "getDownloadAgreements", "parameters": [ { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "A filter expression restricting which items are returned, e.g. \"ModifiedOn in today\". Omit to return all items the caller may see. The query parameter is the canonical location for this filter; the same value may alternatively be sent as a same-named request header.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "The property to sort by, optionally suffixed to control direction, e.g. \"createdOn\". Omit for the endpoint's default order. May also be sent as a same-named request header.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "1-based page number, used together with \"pageSize\". Defaults to the first page. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Number of items per page, used together with \"page\". Too high values will be capped. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of items to skip, used together with \"take\" as an alternative to \"page\"/\"pageSize\". May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "take", "in": "query", "description": "Number of items to return, used together with \"skip\" as an alternative to \"page\"/\"pageSize\". Too high values will be capped. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/DownloadAgreementResource" } }, "page": { "type": [ "null", "integer" ] }, "pageSize": { "type": [ "null", "integer" ] }, "totalCount": { "type": "integer", "format": "int64" } }, "description": "A paged/collection response envelope." } }, "application/hal+json": { "schema": { "required": [ "_links" ], "type": "object", "properties": { "_links": { "type": "object", "properties": { "self": { "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/DownloadAgreementResource" } }, "page": { "type": [ "null", "integer" ] }, "pageSize": { "type": [ "null", "integer" ] }, "totalCount": { "type": "integer", "format": "int64" } }, "description": "A paged/collection response envelope." } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "post": { "tags": [ "Download agreement" ], "summary": "Create a new download agreement", "operationId": "createDownloadAgreements", "parameters": [ { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DownloadAgreementCreateCommand" }, "example": { "enabled": true, "userGroups": { "addOrUpdate": [ "21D41EB1-8323-4B0C-BE7B-6A9C898B1DE1", "CEC3DFC2-4E30-4A69-AA92-2398A3D96C13" ] }, "classifications": { "addOrUpdate": [ "5D57CE75-2A5E-4A41-A6C9-B15D010B32A1", "5b9b9fe0f1294448b2cab18e00e1187b" ] }, "contents": { "addOrUpdate": [ { "languageId": "C2BD4F9B-BB95-4BCB-80C3-1E924C9C26DC", "title": "Download agreement title in English", "termsOfUse": "Actual download agreement text in English " }, { "languageId": "691A7C86-57DC-4330-A512-C616DB954D6A", "title": "Endbenutzer-Lizenzvertrag (Download agreement)", "termsOfUse": "Some download agreement in German." } ] } } } }, "required": true }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatedResourceIdOfInt32" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/downloadAgreements/search": { "post": { "tags": [ "Download agreement" ], "summary": "Search for applicable download agreements matching the given criteria", "operationId": "createDownloadAgreementsSearch", "parameters": [ { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "A filter expression restricting which items are returned, e.g. \"ModifiedOn in today\". Omit to return all items the caller may see. The query parameter is the canonical location for this filter; the same value may alternatively be sent as a same-named request header.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "The property to sort by, optionally suffixed to control direction, e.g. \"createdOn\". Omit for the endpoint's default order. May also be sent as a same-named request header.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "1-based page number, used together with \"pageSize\". Defaults to the first page. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Number of items per page, used together with \"page\". Too high values will be capped. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of items to skip, used together with \"take\" as an alternative to \"page\"/\"pageSize\". May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "take", "in": "query", "description": "Number of items to return, used together with \"skip\" as an alternative to \"page\"/\"pageSize\". Too high values will be capped. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "string" }, "example": { "recordIds": [ "21D41EB1-8323-4B0C-BE7B-6A9C898B1DE1", "CEC3DFC2-4E30-4A69-AA92-2398A3D96C13" ] } } }, "required": true }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DownloadAgreementResource" } } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/downloadagreement/{downloadAgreementId}/classifications": { "get": { "tags": [ "Download agreement" ], "summary": "Read all classifications of a download agreement", "operationId": "getDownloadagreementClassificationsByDownloadAgreementId", "parameters": [ { "name": "downloadAgreementId", "in": "path", "description": "id of the download agreement", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "The property to sort by, optionally suffixed to control direction, e.g. \"createdOn\". Omit for the endpoint's default order. May also be sent as a same-named request header.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "1-based page number, used together with \"pageSize\". Defaults to the first page. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Number of items per page, used together with \"page\". Too high values will be capped. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of items to skip, used together with \"take\" as an alternative to \"page\"/\"pageSize\". May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "take", "in": "query", "description": "Number of items to return, used together with \"skip\" as an alternative to \"page\"/\"pageSize\". Too high values will be capped. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "$ref": "#/components/mediaTypes/DownloadAgreementClassificationCollectionResourceJson" }, "application/hal+json": { "$ref": "#/components/mediaTypes/DownloadAgreementClassificationCollectionResourceHal" } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/downloadagreement/{downloadAgreementId}/contents": { "get": { "tags": [ "Download agreement" ], "summary": "Read all download agreement contents of a download agreement", "operationId": "getDownloadagreementContentsByDownloadAgreementId", "parameters": [ { "name": "downloadAgreementId", "in": "path", "description": "id of the download agreement", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "The property to sort by, optionally suffixed to control direction, e.g. \"createdOn\". Omit for the endpoint's default order. May also be sent as a same-named request header.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "1-based page number, used together with \"pageSize\". Defaults to the first page. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Number of items per page, used together with \"page\". Too high values will be capped. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of items to skip, used together with \"take\" as an alternative to \"page\"/\"pageSize\". May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "take", "in": "query", "description": "Number of items to return, used together with \"skip\" as an alternative to \"page\"/\"pageSize\". Too high values will be capped. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "$ref": "#/components/mediaTypes/DownloadAgreementContentCollectionResourceJson" }, "application/hal+json": { "$ref": "#/components/mediaTypes/DownloadAgreementContentCollectionResourceHal" } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/downloadagreement/{downloadAgreementId}/usergroups": { "get": { "tags": [ "Download agreement" ], "summary": "Read all user groups of a download agreement", "operationId": "getDownloadagreementUsergroupsByDownloadAgreementId", "parameters": [ { "name": "downloadAgreementId", "in": "path", "description": "id of the download agreement", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "The property to sort by, optionally suffixed to control direction, e.g. \"createdOn\". Omit for the endpoint's default order. May also be sent as a same-named request header.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "1-based page number, used together with \"pageSize\". Defaults to the first page. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Number of items per page, used together with \"page\". Too high values will be capped. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of items to skip, used together with \"take\" as an alternative to \"page\"/\"pageSize\". May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "take", "in": "query", "description": "Number of items to return, used together with \"skip\" as an alternative to \"page\"/\"pageSize\". Too high values will be capped. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "$ref": "#/components/mediaTypes/DownloadAgreementUserGroupCollectionResourceJson" }, "application/hal+json": { "$ref": "#/components/mediaTypes/DownloadAgreementUserGroupCollectionResourceHal" } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/downloadagreementcontent/{downloadAgreementContentId}": { "get": { "tags": [ "Download agreement content" ], "summary": "Read a download agreement's content", "description": "### Examples\n\nSearching for a single download agreement content by its ID\n\n```http\nGET /downloadagreementcontent/1\n```", "operationId": "getDownloadagreementcontentByDownloadAgreementContentId", "parameters": [ { "name": "downloadAgreementContentId", "in": "path", "description": "id of the download agreement content", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DownloadAgreementContentResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/downloadlink/{downloadLinkId}": { "get": { "tags": [ "Download link" ], "summary": "Read a download link", "description": "### Examples\n\nReading a download link without embedded targets\n\nIn case of **hal+json**, all subresources (targets) are represented as links to these resources.\n\nIn case of **json**, all subresources (targets) are returned as null values.\n\nSee the `Reading a download link without embedded targets (hal+json)` and `Reading a download link without embedded targets (json)` response examples in the responses panel.\n\n```http\nGET /downloadlink/b6d2400e-ffce-489b-9e08-7324c9378206\naccept: application/hal+json\n```\n\n```http\nGET /downloadlink/b6d2400e-ffce-489b-9e08-7324c9378206\naccept: application/json\n```\n\nReading a download link with embedded targets\n\nRead a download link and embed targets.\n\n```http\nGET /downloadlink/e8a98a7a0ac1440ba538ad44011948d5\naccept: application/hal+json\nselect-downloadlink: targets\n```", "operationId": "getDownloadlinkByDownloadLinkId", "parameters": [ { "name": "downloadLinkId", "in": "path", "description": "id of the download link", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" }, "examples": { "read": { "value": "application/hal+json" }, "read-2": { "value": "application/json" }, "read-select": { "value": "application/hal+json" } } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DownloadLinkResource" }, "examples": { "read": { "summary": "Reading a download link without embedded targets (hal+json)", "value": { "_links": { "targets": { "href": "/downloadlink/11489c63d7ac42da916ba4e901008807/targets", "select-key": "targets" }, "self": { "href": "/downloadlink/11489c63-d7ac-42da-916b-a4e901008807" } }, "createdOn": "2015-08-03T15:31:43.633", "id": "11489c63d7ac42da916ba4e901008807", "status": "Pending", "type": "DownloadOrder", "deliveredFiles": [ "someFilePath1" ], "title": "file3.png", "description": "Download for web" } }, "read-2": { "summary": "Reading a download link without embedded targets (json)", "value": { "targets": null, "createdOn": "2015-08-03T15:31:43.633", "id": "11489c63d7ac42da916ba4e901008807", "status": "Pending", "type": "ExportMaintenanceJob", "deliveredFiles": [ "https://tenant.aprimo.com/api/core/download?token=aaEdw-pxG7OsCNORW" ], "title": "Exported metadata of file3.png", "description": "Export metadata" } }, "read-select": { "summary": "Reading a download link with embedded targets", "value": { "createdOn": "2015-08-03T15:31:43.633", "id": "11489c63d7ac42da916ba4e901008807", "status": "Pending", "type": "ContactSheet", "deliveredFiles": [ "someFilePath1" ], "title": "Contact sheet of 1 item", "description": "Export contact sheet", "_embedded": { "targets": { "_links": { "self": { "href": "https://tenant.aprimo.com/api/core/downloadlink/e8a98a7a0ac1440ba538ad44011948d5/targets" } }, "items": [ { "_links": { "self": { "href": "https://tenant.aprimo.com/api/core/downloadlink/e8a98a7a0ac1440ba538ad44011948d5/target/e7117807489947cd99b227159b9d0741" } }, "recordId": "796de42e712a4ff7a871ad3200c6b9b5", "fileVersionId": "fcfb891859474a9f91e1ad3200c6c1a8", "id": "e7117807489947cd99b227159b9d0741", "status": "Succeeded" } ] } } } } } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/downloadlinks": { "get": { "tags": [ "Download link" ], "summary": "Read a collection of download links", "description": "### Examples\n\nSearching for download links (HTTP headers)\n\n```http\nGET /downloadlinks\naccept: application/hal+json\nfilter: CreatedOn in today\nsort: createdon\npage: 1\npageSize: 20\n```\n\nSearching for download links (query string parameters)\n\n```http\nGET /downloadlinks?filter=CreatedOn+in+today&sort=createdon&page=1&pagesize=10\n```\n\nSearching for download links (headers + query string combined)\n\n```http\nGET /downloadlinks?filter=CreatedOn+in+today&sort=createdon\nskip: 30\ntake: 20\n```", "operationId": "getDownloadlinks", "parameters": [ { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "A filter expression restricting which items are returned, e.g. \"ModifiedOn in today\". Omit to return all items the caller may see. The query parameter is the canonical location for this filter; the same value may alternatively be sent as a same-named request header.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "The property to sort by, optionally suffixed to control direction, e.g. \"createdOn\". Omit for the endpoint's default order. May also be sent as a same-named request header.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "1-based page number, used together with \"pageSize\". Defaults to the first page. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Number of items per page, used together with \"page\". Too high values will be capped. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of items to skip, used together with \"take\" as an alternative to \"page\"/\"pageSize\". May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "take", "in": "query", "description": "Number of items to return, used together with \"skip\" as an alternative to \"page\"/\"pageSize\". Too high values will be capped. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "title": "Download link paged collection resource", "type": "object", "properties": { "pageNumber": { "type": [ "null", "integer" ], "description": "The current page of this paged collection.", "format": "int32" }, "pageSize": { "type": [ "null", "integer" ], "description": "The current page size of this paged collection.", "format": "int32" }, "skip": { "type": [ "null", "integer" ], "description": "The current skip size of this paged collection.", "format": "int32" }, "take": { "type": [ "null", "integer" ], "description": "The current take size of this paged collection.", "format": "int32" }, "totalCount": { "type": "integer", "description": "The total count of items in this paged collection, not just on the current page.", "format": "int64" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/DownloadLinkResource" }, "description": "One page of this paged collection, which is a subcollection of the complete collection." } }, "description": "This page describes how you can get a paged collection of download links (output from maintenance jobs) that users have created. There are 4 types of download links corresponding with the maintenance job type they originate from: download orders, metadata exports, contact sheets, and audit exports." } }, "application/hal+json": { "schema": { "required": [ "_links" ], "$ref": "#/components/schemas/DownloadLinkPagedCollectionResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/downloadlink/{downloadLinkId}/targets": { "get": { "tags": [ "Download link" ], "summary": "Read all targets of a download link", "operationId": "getDownloadlinkTargetsByDownloadLinkId", "parameters": [ { "name": "downloadLinkId", "in": "path", "description": "id of the download link", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "$ref": "#/components/mediaTypes/DownloadLinkTargetCollectionResourceJson" }, "application/hal+json": { "$ref": "#/components/mediaTypes/DownloadLinkTargetCollectionResourceHal" } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/downloadlinks/{downloadId}/downloadagreement/{contentId}/acceptance": { "post": { "tags": [ "Download link" ], "summary": "Insert the download agreement acceptance for a download", "description": "### Examples\n\nAccepting a download agreement for download\n\nConfirms the logged-in user's acceptance of the terms in their language version of the agreement.\n\n```http\nPOST /downloadlinks/8735a5a3e75a4bc0a2a1a3cd0069b669/downloadagreement/135/acceptance\n```", "operationId": "createDownloadlinksDownloadagreementAcceptanceByDownloadIdAndContentId", "parameters": [ { "name": "downloadId", "in": "path", "description": "id of the download", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "contentId", "in": "path", "description": "id of the download agreement's content", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatedResourceId" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/fielddefinition/{fieldDefinitionId}": { "get": { "tags": [ "Field definition" ], "summary": "Read a field definition", "operationId": "getFielddefinitionByFieldDefinitionId", "parameters": [ { "name": "fieldDefinitionId", "in": "path", "description": "id of the field definition", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HtmlFieldDefinitionResource" }, { "$ref": "#/components/schemas/MultiLineTextFieldDefinitionResource" }, { "$ref": "#/components/schemas/SingleLineTextFieldDefinitionResource" }, { "$ref": "#/components/schemas/JsonFieldDefinitionResource" }, { "$ref": "#/components/schemas/NumericFieldDefinitionResource" }, { "$ref": "#/components/schemas/ClassificationListFieldDefinitionResource" }, { "$ref": "#/components/schemas/DateFieldDefinitionResource" }, { "$ref": "#/components/schemas/DateTimeFieldDefinitionResource" }, { "$ref": "#/components/schemas/DurationFieldDefinitionResource" }, { "$ref": "#/components/schemas/OptionListFieldDefinitionResource" }, { "$ref": "#/components/schemas/RecordLinkFieldDefinitionResource" }, { "$ref": "#/components/schemas/RecordListFieldDefinitionResource" }, { "$ref": "#/components/schemas/TimeFieldDefinitionResource" }, { "$ref": "#/components/schemas/UserListFieldDefinitionResource" }, { "$ref": "#/components/schemas/UserGroupListFieldDefinitionResource" }, { "$ref": "#/components/schemas/LanguageListFieldDefinitionResource" }, { "$ref": "#/components/schemas/TextListFieldDefinitionResource" }, { "$ref": "#/components/schemas/HyperlinkListFieldDefinitionResource" } ] } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "put": { "tags": [ "Field definition" ], "summary": "Edit an existing field definition", "operationId": "updateFielddefinitionByFieldDefinitionId", "parameters": [ { "name": "fieldDefinitionId", "in": "path", "description": "id of the field definition", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldDefinitionEditCommand" }, "example": { "enabledLanguages": { "remove": [ "54DFBAA2-98A3-4480-A9B2-2AD582304E0B" ] }, "isReadOnly": true, "childClassifications": { "addOrUpdate": [ "35C0807A-F46A-4D68-BC99-2E194D2255C3" ], "remove": [ "85FEC6C5-CF3F-44FB-A9E0-C43BE77EFC1E" ] }, "showSummaryImage": true, "defaultValue": "default value", "resetToDefaultTriggers": [ "onNewField", "OnLoad", "OnFieldChange" ], "resetToDefaultFields": [ "f0a63fe8-5ffe-49c2-8198-b81976a1cce8", "3cf7281e-787d-4336-9827-990388017911", "6e9807ce-16bd-4960-bda1-b26327633896" ], "validationTrigger": "always", "validation": "", "validationErrorMessage": "validation error message", "storageMode": "logChanges" } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "delete": { "tags": [ "Field definition" ], "summary": "Delete the specified field definition", "description": "### Examples\n\nDeleting a field definition\n\n```http\nDELETE /fielddefinition/c584888369ab4f049f367ea9f19137e3\n```", "operationId": "deleteFielddefinitionByFieldDefinitionId", "parameters": [ { "name": "fieldDefinitionId", "in": "path", "description": "id of the field definition", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/fielddefinitions": { "get": { "tags": [ "Field definition" ], "summary": "Read a collection of field definitions", "description": "### Examples\n\nSearching for field definitions (HTTP headers)\n\n```http\nGET /fielddefinitions\naccept: application/hal+json\nfilter: ModifiedOn in today\nsort: createdon\npage: 1\npageSize: 20\n```\n\nSearching for field definitions (query string parameters)\n\n```http\nGET /fielddefinitions?filter=ModifiedOn+in+today&sort=createdon&page=1&pagesize=10\n```\n\nSearching for field definitions (headers + query string combined)\n\n```http\nGET /fielddefinitions?page=1&pagesize=10\nfilter: ModifiedOn in today\nsort: createdon\n```", "operationId": "getFielddefinitions", "parameters": [ { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "A filter expression restricting which items are returned, e.g. \"ModifiedOn in today\". Omit to return all items the caller may see. The query parameter is the canonical location for this filter; the same value may alternatively be sent as a same-named request header.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "The property to sort by, optionally suffixed to control direction, e.g. \"createdOn\". Omit for the endpoint's default order. May also be sent as a same-named request header.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "1-based page number, used together with \"pageSize\". Defaults to the first page. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Number of items per page, used together with \"page\". Too high values will be capped. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of items to skip, used together with \"take\" as an alternative to \"page\"/\"pageSize\". May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "take", "in": "query", "description": "Number of items to return, used together with \"skip\" as an alternative to \"page\"/\"pageSize\". Too high values will be capped. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "title": "Field definition paged collection resource", "type": "object", "properties": { "pageNumber": { "type": [ "null", "integer" ], "description": "The current page of this paged collection.", "format": "int32" }, "pageSize": { "type": [ "null", "integer" ], "description": "The current page size of this paged collection.", "format": "int32" }, "skip": { "type": [ "null", "integer" ], "description": "The current skip size of this paged collection.", "format": "int32" }, "take": { "type": [ "null", "integer" ], "description": "The current take size of this paged collection.", "format": "int32" }, "totalCount": { "type": "integer", "description": "The total count of items in this paged collection, not just on the current page.", "format": "int64" }, "items": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/HtmlFieldDefinitionResource" }, { "$ref": "#/components/schemas/MultiLineTextFieldDefinitionResource" }, { "$ref": "#/components/schemas/SingleLineTextFieldDefinitionResource" }, { "$ref": "#/components/schemas/JsonFieldDefinitionResource" }, { "$ref": "#/components/schemas/NumericFieldDefinitionResource" }, { "$ref": "#/components/schemas/ClassificationListFieldDefinitionResource" }, { "$ref": "#/components/schemas/DateFieldDefinitionResource" }, { "$ref": "#/components/schemas/DateTimeFieldDefinitionResource" }, { "$ref": "#/components/schemas/DurationFieldDefinitionResource" }, { "$ref": "#/components/schemas/OptionListFieldDefinitionResource" }, { "$ref": "#/components/schemas/RecordLinkFieldDefinitionResource" }, { "$ref": "#/components/schemas/RecordListFieldDefinitionResource" }, { "$ref": "#/components/schemas/TimeFieldDefinitionResource" }, { "$ref": "#/components/schemas/UserListFieldDefinitionResource" }, { "$ref": "#/components/schemas/UserGroupListFieldDefinitionResource" }, { "$ref": "#/components/schemas/LanguageListFieldDefinitionResource" }, { "$ref": "#/components/schemas/TextListFieldDefinitionResource" }, { "$ref": "#/components/schemas/HyperlinkListFieldDefinitionResource" } ] }, "description": "One page of this paged collection, which is a subcollection of the complete collection." } }, "description": "Representation of a paged collection of field definitions" } }, "application/hal+json": { "schema": { "required": [ "_links" ], "$ref": "#/components/schemas/FieldDefinitionPagedCollectionResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "post": { "tags": [ "Field definition" ], "summary": "Create a new field definition", "operationId": "createFielddefinitions", "parameters": [ { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ClassificationListFieldDefinitionCreateCommand" }, { "$ref": "#/components/schemas/DateFieldDefinitionCreateCommand" }, { "$ref": "#/components/schemas/DateTimeFieldDefinitionCreateCommand" }, { "$ref": "#/components/schemas/DurationFieldDefinitionCreateCommand" }, { "$ref": "#/components/schemas/HtmlFieldDefinitionCreateCommand" }, { "$ref": "#/components/schemas/JsonFieldDefinitionCreateCommand" }, { "$ref": "#/components/schemas/LanguageListFieldDefinitionCreateCommand" }, { "$ref": "#/components/schemas/MultiLineTextFieldDefinitionCreateCommand" }, { "$ref": "#/components/schemas/NumericFieldDefinitionCreateCommand" }, { "$ref": "#/components/schemas/OptionListFieldDefinitionCreateCommand" }, { "$ref": "#/components/schemas/RecordLinkFieldDefinitionCreateCommand" }, { "$ref": "#/components/schemas/RecordListFieldDefinitionCreateCommand" }, { "$ref": "#/components/schemas/SingleLineTextFieldDefinitionCreateCommand" }, { "$ref": "#/components/schemas/TextListFieldDefinitionCreateCommand" }, { "$ref": "#/components/schemas/HyperlinkListFieldDefinitionCreateCommand" }, { "$ref": "#/components/schemas/TimeFieldDefinitionCreateCommand" }, { "$ref": "#/components/schemas/UserGroupListFieldDefinitionCreateCommand" }, { "$ref": "#/components/schemas/UserListFieldDefinitionCreateCommand" } ], "discriminator": { "propertyName": "dataType", "mapping": { "ClassificationList": "#/components/schemas/ClassificationListFieldDefinitionCreateCommand", "Date": "#/components/schemas/DateFieldDefinitionCreateCommand", "DateTime": "#/components/schemas/DateTimeFieldDefinitionCreateCommand", "Duration": "#/components/schemas/DurationFieldDefinitionCreateCommand", "Html": "#/components/schemas/HtmlFieldDefinitionCreateCommand", "Json": "#/components/schemas/JsonFieldDefinitionCreateCommand", "LanguageList": "#/components/schemas/LanguageListFieldDefinitionCreateCommand", "MultiLineText": "#/components/schemas/MultiLineTextFieldDefinitionCreateCommand", "Numeric": "#/components/schemas/NumericFieldDefinitionCreateCommand", "OptionList": "#/components/schemas/OptionListFieldDefinitionCreateCommand", "RecordLink": "#/components/schemas/RecordLinkFieldDefinitionCreateCommand", "RecordList": "#/components/schemas/RecordListFieldDefinitionCreateCommand", "SingleLineText": "#/components/schemas/SingleLineTextFieldDefinitionCreateCommand", "TextList": "#/components/schemas/TextListFieldDefinitionCreateCommand", "HyperlinkList": "#/components/schemas/HyperlinkListFieldDefinitionCreateCommand", "Time": "#/components/schemas/TimeFieldDefinitionCreateCommand", "UserGroupList": "#/components/schemas/UserGroupListFieldDefinitionCreateCommand", "UserList": "#/components/schemas/UserListFieldDefinitionCreateCommand" } } }, "examples": { "create": { "summary": "Creating a field definition (common attributes)", "value": { "name": "assetCost", "dataType": "numeric", "enabledLanguages": { "addOrUpdate": [ "54DFBAA2-98A3-4480-A9B2-2AD582304E0B" ], "remove": [ ] }, "indexed": false, "inlineStyle": "background: #F00", "isReadOnly": false, "isRequired": false, "labels": [ { "languageId": "54DFBAA2-98A3-4480-A9B2-2AD582304E0B", "value": "Asset Cost" } ], "languageMode": "multiple", "memberships": { "addOrUpdate": [ ], "remove": [ ] }, "scope": "recordContentGlobal", "sortIndex": 10, "tag": "some tag", "defaultValue": "default value", "resetToDefaultTriggers": [ "onNewField", "OnLoad", "OnFieldChange" ], "resetToDefaultFields": [ "f0a63fe8-5ffe-49c2-8198-b81976a1cce8", "3cf7281e-787d-4336-9827-990388017911", "6e9807ce-16bd-4960-bda1-b26327633896" ], "validationTrigger": "always", "validation": "", "validationErrorMessage": "validation error message", "storageMode": "logChanges" } }, "create-classificationList": { "summary": "Creating a classification list field definition", "value": { "name": "Classification List", "dataType": "classificationList", "acceptMultipleOptions": true, "defaultSelectionDisplayMode": "search", "restrictValuesToLeafNodes": true, "linkRecordToSelectedClassifications": true, "filter": "", "rootId": "e20968e3-eee7-4813-bba8-a8c8009ad531" } }, "create-date": { "summary": "Creating a date field definition", "value": { "name": "Start Date", "dataType": "date", "datePattern": "d" } }, "create-datetime": { "summary": "Creating a date/time field definition", "value": { "name": "Timestamp", "dataType": "datetime", "datePattern": "d", "dateTimePattern": "MMMM yyyy", "useUtc": true } }, "create-html": { "summary": "Creating an html field definition", "value": { "name": "Control Body", "dataType": "html", "maximumLength": "40000", "minimumLength": "0", "regularExpression": ".*" } }, "create-multiline": { "summary": "Creating a multiline text field definition", "value": { "name": "Text Block", "dataType": "multiLineText", "maximumLength": "40000", "minimumLength": "0", "regularExpression": ".*" } }, "create-numeric": { "summary": "Creating a numeric field definition", "value": { "name": "Asset Cost", "dataType": "numeric", "accuracy": "0.001", "range": "0-100" } }, "create-optionlist": { "summary": "Creating an option list field definition", "value": { "name": "Asset Theme", "dataType": "optionList", "acceptMultipleOptions": false, "sortOrder": "label", "filter": "", "items": { "addOrUpdate": [ { "id": "0E1EBD21-5932-1234-B76B-A0C0C7924A1D", "name": "themeJungle", "labels": [ { "languageId": "0E1EBD21-5932-4208-B76B-A0C0C7924A1D", "value": "Jungle" }, { "languageId": "B5484390-1262-42CC-AFFD-B10BEEA23799", "value": "Robin des Bois" } ], "tag": "some tag1", "disabledInDAMUI": false }, { "name": "themeYellow", "labels": [ { "languageId": "0E1EBD21-5932-4208-B76B-A0C0C7924A1D", "value": "Yellow" }, { "languageId": "B5484390-1262-42CC-AFFD-B10BEEA23799", "value": "Omelette du Fromage" } ], "tag": "some tag2", "disabledInDAMUI": false } ], "remove": [ ] } } }, "create-recordlink": { "summary": "Creating a record link field definition", "value": { "name": "Related Products", "dataType": "recordLink", "childClassifications": { "addOrUpdate": [ "E4EA127D-6B92-4417-BB8D-A922790B1ABA", "35C0807A-F46A-4D68-BC99-2E194D2255C3" ], "remove": [ ] }, "parentContentTypes": { "addOrUpdate": [ "Video" ], "remove": [ ] }, "linkClassifications": null, "childLabels": [ { "value": "Label for children", "languageID": "c2bd4f9b-bb95-4bcb-80c3-1e924c9c26dc" } ], "parentLabels": [ { "value": "Label for parents", "languageID": "c2bd4f9b-bb95-4bcb-80c3-1e924c9c26dc" } ], "linkType": "ManyParentsManyChildren", "showSummaryImage": false, "summaryFieldId": null } }, "create-recordlist": { "summary": "Creating a record list field definition", "value": { "name": "Component List", "dataType": "recordList", "summaryFieldId": "E42AD166-9238-4271-8EC7-925C1B62F911" } }, "create-singleline": { "summary": "Creating a single line text field definition", "value": { "name": "Text Line", "dataType": "singleLineText", "maximumLength": "40000", "minimumLength": "0", "regularExpression": ".*", "isUniqueIdentifier": false } }, "create-time": { "summary": "Creating a time field definition", "value": { "name": "Text Line", "dataType": "time", "timePattern": "hh,mm:ss" } }, "create-userlist": { "summary": "Creating a user list field definition", "value": { "name": "Text Line", "dataType": "userList", "filter": "" } }, "create-usergrouplist": { "summary": "Creating a user group list field definition", "value": { "name": "Text Line", "dataType": "userGroupList", "filter": "" } } } } }, "required": true }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatedResourceId" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/fielddefinitions/search": { "post": { "tags": [ "Field definition" ], "summary": "Search field definitions with the parameters in the request body", "description": "Search field definitions with the parameters in the request body. Functionally equivalent to GET, but the filter travels in the body so it is not subject to header or query-string size limits.", "operationId": "createFielddefinitionsSearch", "parameters": [ { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldDefinitionSearchBodyResource" }, "example": { "filter": "NOT (Id in '\"e060f1dfb72d42e0971f1dbb63824447\"') ScopeCategory=Record Indexed=true", "skip": 0, "take": 500, "checkEditPermission": false } } }, "required": true }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "title": "Field definition paged collection resource", "type": "object", "properties": { "pageNumber": { "type": [ "null", "integer" ], "description": "The current page of this paged collection.", "format": "int32" }, "pageSize": { "type": [ "null", "integer" ], "description": "The current page size of this paged collection.", "format": "int32" }, "skip": { "type": [ "null", "integer" ], "description": "The current skip size of this paged collection.", "format": "int32" }, "take": { "type": [ "null", "integer" ], "description": "The current take size of this paged collection.", "format": "int32" }, "totalCount": { "type": "integer", "description": "The total count of items in this paged collection, not just on the current page.", "format": "int64" }, "items": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/HtmlFieldDefinitionResource" }, { "$ref": "#/components/schemas/MultiLineTextFieldDefinitionResource" }, { "$ref": "#/components/schemas/SingleLineTextFieldDefinitionResource" }, { "$ref": "#/components/schemas/JsonFieldDefinitionResource" }, { "$ref": "#/components/schemas/NumericFieldDefinitionResource" }, { "$ref": "#/components/schemas/ClassificationListFieldDefinitionResource" }, { "$ref": "#/components/schemas/DateFieldDefinitionResource" }, { "$ref": "#/components/schemas/DateTimeFieldDefinitionResource" }, { "$ref": "#/components/schemas/DurationFieldDefinitionResource" }, { "$ref": "#/components/schemas/OptionListFieldDefinitionResource" }, { "$ref": "#/components/schemas/RecordLinkFieldDefinitionResource" }, { "$ref": "#/components/schemas/RecordListFieldDefinitionResource" }, { "$ref": "#/components/schemas/TimeFieldDefinitionResource" }, { "$ref": "#/components/schemas/UserListFieldDefinitionResource" }, { "$ref": "#/components/schemas/UserGroupListFieldDefinitionResource" }, { "$ref": "#/components/schemas/LanguageListFieldDefinitionResource" }, { "$ref": "#/components/schemas/TextListFieldDefinitionResource" }, { "$ref": "#/components/schemas/HyperlinkListFieldDefinitionResource" } ] }, "description": "One page of this paged collection, which is a subcollection of the complete collection." } }, "description": "Representation of a paged collection of field definitions" } }, "application/hal+json": { "schema": { "required": [ "_links" ], "$ref": "#/components/schemas/FieldDefinitionPagedCollectionResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/fielddefinition/{fieldDefinitionId}/listvalues": { "get": { "tags": [ "Field definition" ], "summary": "Read the list values of a classification list field definition", "operationId": "getFielddefinitionListvaluesByFieldDefinitionId", "parameters": [ { "name": "fieldDefinitionId", "in": "path", "description": "id of the field definition", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "A filter expression restricting which items are returned, e.g. \"ModifiedOn in today\". Omit to return all items the caller may see. The query parameter is the canonical location for this filter; the same value may alternatively be sent as a same-named request header.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "The property to sort by, optionally suffixed to control direction, e.g. \"createdOn\". Omit for the endpoint's default order. May also be sent as a same-named request header.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "1-based page number, used together with \"pageSize\". Defaults to the first page. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Number of items per page, used together with \"page\". Too high values will be capped. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of items to skip, used together with \"take\" as an alternative to \"page\"/\"pageSize\". May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "take", "in": "query", "description": "Number of items to return, used together with \"skip\" as an alternative to \"page\"/\"pageSize\". Too high values will be capped. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "$ref": "#/components/mediaTypes/IPagedCollectionOfClassificationListFieldItemResourceJson" }, "application/hal+json": { "$ref": "#/components/mediaTypes/IPagedCollectionOfClassificationListFieldItemResourceHal" } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/fieldgroup/{fieldGroupId}": { "get": { "tags": [ "Field group" ], "summary": "Read a field group", "operationId": "getFieldgroupByFieldGroupId", "parameters": [ { "name": "fieldGroupId", "in": "path", "description": "id of the field group", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldGroupResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "put": { "tags": [ "Field group" ], "summary": "Edit an existing field group", "operationId": "updateFieldgroupByFieldGroupId", "parameters": [ { "name": "fieldGroupId", "in": "path", "description": "id of the field group", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldGroupEditCommand" }, "example": { "name": "New Group Name", "tag": "xml", "members": { "addOrUpdate": [ "1e2c7000-fbe5-4048-9e5c-a7fb00bc103d" ], "remove": [ "c3782d20-fa8b-4f5b-8aba-a7fb00bd09c0", "0c655ce8-5b9b-4546-b09d-92c728e03e08" ] } } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "delete": { "tags": [ "Field group" ], "summary": "Delete the specified field group", "description": "### Examples\n\nDeleting a field group\n\n```http\nDELETE /fieldgroup/6750869d69e64b6c86b4a7f900898bb4\n```", "operationId": "deleteFieldgroupByFieldGroupId", "parameters": [ { "name": "fieldGroupId", "in": "path", "description": "id of the field group", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/fieldgroups": { "get": { "tags": [ "Field group" ], "summary": "Read a collection of field groups", "description": "### Examples\n\nSearching for field groups (HTTP headers)\n\n```http\nGET /fieldgroups\naccept: application/hal+json\nfilter: ModifiedOn in today\nsort: createdon\npage: 1\npageSize: 20\n```\n\nSearching for field groups (query string parameters)\n\n```http\nGET /fieldgroups?filter=ModifiedOn+in+today&sort=createdon&page=1&pagesize=10\n```\n\nSearching for field groups (headers + query string combined)\n\n```http\nGET /fieldgroups?filter=ModifiedOn+in+today&sort=createdon\npage: 1\npageSize: 20\n```", "operationId": "getFieldgroups", "parameters": [ { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "A filter expression restricting which items are returned, e.g. \"ModifiedOn in today\". Omit to return all items the caller may see. The query parameter is the canonical location for this filter; the same value may alternatively be sent as a same-named request header.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "The property to sort by, optionally suffixed to control direction, e.g. \"createdOn\". Omit for the endpoint's default order. May also be sent as a same-named request header.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "1-based page number, used together with \"pageSize\". Defaults to the first page. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Number of items per page, used together with \"page\". Too high values will be capped. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of items to skip, used together with \"take\" as an alternative to \"page\"/\"pageSize\". May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "take", "in": "query", "description": "Number of items to return, used together with \"skip\" as an alternative to \"page\"/\"pageSize\". Too high values will be capped. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/FieldGroupResource" } }, "page": { "type": [ "null", "integer" ] }, "pageSize": { "type": [ "null", "integer" ] }, "totalCount": { "type": "integer", "format": "int64" } }, "description": "A paged/collection response envelope." } }, "application/hal+json": { "schema": { "required": [ "_links" ], "type": "object", "properties": { "_links": { "type": "object", "properties": { "self": { "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/FieldGroupResource" } }, "page": { "type": [ "null", "integer" ] }, "pageSize": { "type": [ "null", "integer" ] }, "totalCount": { "type": "integer", "format": "int64" } }, "description": "A paged/collection response envelope." } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "post": { "tags": [ "Field group" ], "summary": "Create a new field group", "operationId": "createFieldgroups", "parameters": [ { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/FieldGroupCreateCommand" } ] }, "example": { "name": "myfieldgroupname", "tag": "xml", "members": { "addOrUpdate": [ "1e2c7000-fbe5-4048-9e5c-a7fb00bc103d" ], "remove": [ "c3782d20-fa8b-4f5b-8aba-a7fb00bd09c0", "0c655ce8-5b9b-4546-b09d-92c728e03e08" ] } } } }, "required": true }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatedResourceId" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/fieldgroup/{fieldGroupId}/createdby": { "get": { "tags": [ "Field group" ], "summary": "Read the user who created the field group", "operationId": "getFieldgroupCreatedbyByFieldGroupId", "parameters": [ { "name": "fieldGroupId", "in": "path", "description": "id of the field group", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/fieldgroup/{fieldGroupId}/members": { "get": { "tags": [ "Field group" ], "summary": "Get the members of the field group", "operationId": "getFieldgroupMembersByFieldGroupId", "parameters": [ { "name": "fieldGroupId", "in": "path", "description": "id of the field group", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "$ref": "#/components/mediaTypes/FieldDefinitionCollectionResourceJson" }, "application/hal+json": { "$ref": "#/components/mediaTypes/FieldDefinitionCollectionResourceHal" } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/fieldgroup/{fieldGroupId}/modifiedby": { "get": { "tags": [ "Field group" ], "summary": "Read the user who last modified the field group", "operationId": "getFieldgroupModifiedbyByFieldGroupId", "parameters": [ { "name": "fieldGroupId", "in": "path", "description": "id of the field group", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/fieldpopulationlog/summary": { "get": { "tags": [ "Field population log" ], "summary": "Read a collection of field population log summary entries", "operationId": "getFieldpopulationlogSummary", "parameters": [ { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "The property to sort by, optionally suffixed to control direction, e.g. \"createdOn\". Omit for the endpoint's default order. May also be sent as a same-named request header.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "1-based page number, used together with \"pageSize\". Defaults to the first page. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Number of items per page, used together with \"page\". Too high values will be capped. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of items to skip, used together with \"take\" as an alternative to \"page\"/\"pageSize\". May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "take", "in": "query", "description": "Number of items to return, used together with \"skip\" as an alternative to \"page\"/\"pageSize\". Too high values will be capped. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "$ref": "#/components/mediaTypes/IPagedCollectionResourceOfFieldPopulationLogSummaryResourceJson" }, "application/hal+json": { "$ref": "#/components/mediaTypes/IPagedCollectionResourceOfFieldPopulationLogSummaryResourceHal" } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/fieldpopulationlog/recent/{fieldId}": { "get": { "tags": [ "Field population log" ], "summary": "Read a collection of field population log prediction entries", "operationId": "getFieldpopulationlogRecentByFieldId", "parameters": [ { "name": "fieldId", "in": "path", "description": "The ID of the Field Predictions to be retrieved.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "The property to sort by, optionally suffixed to control direction, e.g. \"createdOn\". Omit for the endpoint's default order. May also be sent as a same-named request header.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "1-based page number, used together with \"pageSize\". Defaults to the first page. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Number of items per page, used together with \"page\". Too high values will be capped. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of items to skip, used together with \"take\" as an alternative to \"page\"/\"pageSize\". May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "take", "in": "query", "description": "Number of items to return, used together with \"skip\" as an alternative to \"page\"/\"pageSize\". Too high values will be capped. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "$ref": "#/components/mediaTypes/IPagedCollectionResourceOfFieldPopulationLogPredictionResourceJson" }, "application/hal+json": { "$ref": "#/components/mediaTypes/IPagedCollectionResourceOfFieldPopulationLogPredictionResourceHal" } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/file/{fileId}": { "get": { "tags": [ "File" ], "summary": "Read a file", "description": "### Examples\n\nUploading a file\n\nSee the Uploading files overview section for details.\n\nAdding or updating a record's file\n\nAfter a file upload process is finished, you will receive a file upload token. You can use this token to add or update a record's files or file versions. See the examples on creating a record (POST /records) and editing a record (PUT /record/{recordId}) for more details on how to do it. Keep in mind, the file upload token can be consumed only once. **404 Not Found** error response is returned if you try consuming a token more than once.\n\nApplying a watermark to a file\n\nConfigured through the creation of a record (POST /records) and/or editing of a record (PUT /record/{recordId}). For more info, see the Watermark resource page.", "operationId": "getFileByFileId", "parameters": [ { "name": "fileId", "in": "path", "description": "id of the file", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/file/{fileId}/fields": { "get": { "tags": [ "File" ], "summary": "Read all fields of a file", "operationId": "getFileFieldsByFileId", "parameters": [ { "name": "fileId", "in": "path", "description": "id of the file", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "1-based page number, used together with \"pageSize\". Defaults to the first page. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Number of items per page, used together with \"page\". Too high values will be capped. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of items to skip, used together with \"take\" as an alternative to \"page\"/\"pageSize\". May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "take", "in": "query", "description": "Number of items to return, used together with \"skip\" as an alternative to \"page\"/\"pageSize\". Too high values will be capped. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "$ref": "#/components/mediaTypes/FieldCollectionResourceJson" }, "application/hal+json": { "$ref": "#/components/mediaTypes/FieldCollectionResourceHal" } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/file/{fileId}/fileversions": { "get": { "tags": [ "File" ], "summary": "Read all file versions of a file", "operationId": "getFileFileversionsByFileId", "parameters": [ { "name": "fileId", "in": "path", "description": "id of the file", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "The property to sort by, optionally suffixed to control direction, e.g. \"createdOn\". Omit for the endpoint's default order. May also be sent as a same-named request header.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "1-based page number, used together with \"pageSize\". Defaults to the first page. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Number of items per page, used together with \"page\". Too high values will be capped. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of items to skip, used together with \"take\" as an alternative to \"page\"/\"pageSize\". May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "take", "in": "query", "description": "Number of items to return, used together with \"skip\" as an alternative to \"page\"/\"pageSize\". Too high values will be capped. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/FileVersionPagedCollectionResource" }, { "$ref": "#/components/schemas/FileVersionCollectionResource" } ] } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/file/{fileId}/latestversion": { "get": { "tags": [ "File" ], "summary": "Read the latest file version", "operationId": "getFileLatestversionByFileId", "parameters": [ { "name": "fileId", "in": "path", "description": "id of the file", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileVersionResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/file/{fileId}/watermark": { "get": { "tags": [ "File" ], "summary": "Read the watermark of a file", "operationId": "getFileWatermarkByFileId", "parameters": [ { "name": "fileId", "in": "path", "description": "id of the file", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WatermarkResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/file/{fileId}/checkouts": { "post": { "tags": [ "File" ], "summary": "Check out a file", "description": "### Examples\n\nChecking a file out and back in\n\nNo body needs to be specified.\n\nChecking the file back in is an implicit operation that happens automatically when adding a new file version to a checked out file.\n\n```http\nPOST /file/4535a5a3e75a4bc0a341a3cd0069b675/checkouts\n```", "operationId": "createFileCheckoutsByFileId", "parameters": [ { "name": "fileId", "in": "path", "description": "id of the file", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Success" }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "delete": { "tags": [ "File" ], "summary": "Undo the checkout of a file", "description": "### Examples\n\nUndoing a file checkout\n\nNo body needs to be specified.\n\n```http\nDELETE /file/4535a5a3e75a4bc0a341a3cd0069b675/checkouts\n```", "operationId": "deleteFileCheckoutsByFileId", "parameters": [ { "name": "fileId", "in": "path", "description": "id of the file", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/file/{fileId}/field/{fieldId}": { "get": { "tags": [ "File" ], "summary": "Read a field of a file", "operationId": "getFileFieldByFileIdAndFieldId", "parameters": [ { "name": "fileId", "in": "path", "description": "id of the file", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "fieldId", "in": "path", "description": "id of the field", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/SingleLineTextFieldResource" }, { "$ref": "#/components/schemas/MultiLineTextFieldResource" }, { "$ref": "#/components/schemas/NumericFieldResource" }, { "$ref": "#/components/schemas/DateTimeFieldResource" }, { "$ref": "#/components/schemas/DateFieldResource" }, { "$ref": "#/components/schemas/TimeFieldResource" }, { "$ref": "#/components/schemas/OptionListFieldResource" }, { "$ref": "#/components/schemas/DurationFieldResource" }, { "$ref": "#/components/schemas/UserListFieldResource" }, { "$ref": "#/components/schemas/UserGroupListFieldResource" }, { "$ref": "#/components/schemas/HtmlFieldResource" }, { "$ref": "#/components/schemas/JsonFieldResource" }, { "$ref": "#/components/schemas/ClassificationListFieldResource" }, { "$ref": "#/components/schemas/RecordListFieldResource" }, { "$ref": "#/components/schemas/RecordLinkFieldResource" }, { "$ref": "#/components/schemas/LanguageListFieldResource" }, { "$ref": "#/components/schemas/TextListFieldResource" }, { "$ref": "#/components/schemas/HyperlinkListFieldResource" } ], "discriminator": { "propertyName": "dataType", "mapping": { "SingleLineText": "#/components/schemas/SingleLineTextFieldResource", "MultiLineText": "#/components/schemas/MultiLineTextFieldResource", "Numeric": "#/components/schemas/NumericFieldResource", "DateTime": "#/components/schemas/DateTimeFieldResource", "Date": "#/components/schemas/DateFieldResource", "Time": "#/components/schemas/TimeFieldResource", "OptionList": "#/components/schemas/OptionListFieldResource", "Duration": "#/components/schemas/DurationFieldResource", "UserList": "#/components/schemas/UserListFieldResource", "UserGroupList": "#/components/schemas/UserGroupListFieldResource", "Html": "#/components/schemas/HtmlFieldResource", "Json": "#/components/schemas/JsonFieldResource", "ClassificationList": "#/components/schemas/ClassificationListFieldResource", "RecordList": "#/components/schemas/RecordListFieldResource", "RecordLink": "#/components/schemas/RecordLinkFieldResource", "LanguageList": "#/components/schemas/LanguageListFieldResource", "TextList": "#/components/schemas/TextListFieldResource", "HyperlinkList": "#/components/schemas/HyperlinkListFieldResource" } } } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/file/{fileId}/image/preview": { "get": { "tags": [ "File" ], "summary": "Read the preview of this file", "operationId": "getFileImagePreviewByFileId", "parameters": [ { "name": "fileId", "in": "path", "description": "id of the file", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImageResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/file/{fileId}/image/thumbnail": { "get": { "tags": [ "File" ], "summary": "Read the thumbnail of this file", "operationId": "getFileImageThumbnailByFileId", "parameters": [ { "name": "fileId", "in": "path", "description": "id of the file", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImageResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/filepreview/{filePreviewId}": { "get": { "tags": [ "File preview" ], "summary": "Read the preview of a file", "description": "### Examples\n\nUploading a file preview\n\nSee the Uploading files overview section for details.\n\nAdding or updating a file preview\n\nAfter a file preview upload process is finished, you will receive a file upload token. You can use this token to add or update a file preview. See the examples on creating a record (POST /records) and editing a record (PUT /record/{recordId}) for more details on how to do it. Keep in mind, the file upload token can be consumed only once. **404 Not Found** error response is returned if you try consuming that token more than once.\n\nWhen adding a file version of a supported format, a preview can be generated automatically. If you want to edit the metadata of this automatically generated preview in the same request you send to create the version, you can do this by specifying the same file upload token used to add the file version as id of the preview. This will not be considered consuming the token, but is only used as convention to address the autogenerated file preview.", "operationId": "getFilepreviewByFilePreviewId", "parameters": [ { "name": "filePreviewId", "in": "path", "description": "id of the file preview", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilePreviewResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/filepreview/{filePreviewId}/rotationAngle": { "patch": { "tags": [ "File preview" ], "summary": "Edit the rotation angle of a file preview", "operationId": "patchFilepreviewRotationAngleByFilePreviewId", "parameters": [ { "name": "filePreviewId", "in": "path", "description": "id of the file preview", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilePreviewRotationAngleCommand" } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/filepreview/{filePreviewId}/image/preview": { "get": { "tags": [ "File preview" ], "summary": "Read the preview from a filepreview", "operationId": "getFilepreviewImagePreviewByFilePreviewId", "parameters": [ { "name": "filePreviewId", "in": "path", "description": "id of the filepreview", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImageResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/filepreview/{filePreviewId}/image/thumbnail": { "get": { "tags": [ "File preview" ], "summary": "Read the thumbnail from a filepreview", "operationId": "getFilepreviewImageThumbnailByFilePreviewId", "parameters": [ { "name": "filePreviewId", "in": "path", "description": "id of the filepreview", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImageResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/fileprocessaction/{fileProcessActionId}": { "get": { "tags": [ "File process action" ], "summary": "Read a file process action", "operationId": "getFileprocessactionByFileProcessActionId", "parameters": [ { "name": "fileProcessActionId", "in": "path", "description": "id of the file process action", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileProcessActionResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "put": { "tags": [ "File process action" ], "summary": "Edit a file process action", "operationId": "updateFileprocessactionByFileProcessActionId", "parameters": [ { "name": "fileProcessActionId", "in": "path", "description": "id of the file process action", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileProcessActionEditCommand" } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/fileprocessactions": { "get": { "tags": [ "File process action" ], "summary": "Read a collection of file process actions", "operationId": "getFileprocessactions", "parameters": [ { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "$ref": "#/components/mediaTypes/IPagedCollectionResourceOfFileProcessActionResourceJson" }, "application/hal+json": { "$ref": "#/components/mediaTypes/IPagedCollectionResourceOfFileProcessActionResourceHal" } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/filetype/{fileTypeId}": { "get": { "tags": [ "File type" ], "summary": "Read a file type", "description": "### Examples\n\nReading a file type\n\nIf the file type was not found, the API call will fail with a **404 Not found** HTTP status code.\n\n```http\nGET /filetype/8130e27dd7114e018734b652b512e8dc\n```", "operationId": "getFiletypeByFileTypeId", "parameters": [ { "name": "fileTypeId", "in": "path", "description": "id of the file type", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileTypeResource" }, "example": { "_links": { "icon": { "href": "/filetype/8130e27dd7114e018734b652b512e8dc/image/icon", "select-key": "icon" }, "thumbnail": { "href": "/filetype/8130e27dd7114e018734b652b512e8dc/image/thumbnail", "select-key": "thumbnail" }, "modifiedby": { "href": "/user/7410e27dd7114e018734b652b512e8dc", "select-key": "modifiedby" }, "createdby": { "href": "/user/7410e27dd7114e018734b652b512e8dc", "select-key": "createdby" }, "self": { "href": "/filetype/8130e27dd7114e018734b652b512e8dc" } }, "id": "8130e27dd7114e018734b652b512e8dc", "name": "Archive (ZIP)", "kind": "Zip", "extension": "ZIP", "mimeType": "application/octet-stream", "labels": [ { "value": "Archive (ZIP)", "languageId": "c2bd4f9bbb954bcb80c31e924c9c26dc" } ], "registeredFields": [ ], "registeredFieldGroups": [ ], "engineFormat": "ZIP", "catalogActions": [ ], "mediaEngines": [ ], "previewFormat": "Jpg", "previewPlayers": [ ], "previewRequired": false, "previewKeepDimensions": false, "allowResize": false, "allowWatermark": false, "preferredExtension": true, "tag": null, "modifiedOn": "2017-10-20T05:44:13.487Z", "createdOn": "2017-10-20T05:44:13.487Z" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "put": { "tags": [ "File type" ], "summary": "Edit an existing file type", "operationId": "updateFiletypeByFileTypeId", "parameters": [ { "name": "fileTypeId", "in": "path", "description": "id of the file type", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileTypeEditCommand" }, "example": { "name": "file type name", "kind": "knd", "extension": "ext", "mimeType": "application/json", "thumbnail": "NmMyM2YwZmM0NTVlNDNjYzkzZTdhODI3MDA4MDQ2ODQ=", "icon": "ZmIyNjkyYjcwZTQyNGY1Yjg3YjBhODI3MDA4MDU5ZjU=", "labels": [ { "languageId": "c2bd4f9b-bb95-4bcb-80c3-1e924c9c26dc", "value": "file type name" } ], "isCatalogable": false, "engineFormat": "ef", "catalogActions": { "addOrUpdate": [ { "name": "ReadXmp", "isCritical": false }, { "name": "ReadMetaData", "isCritical": true } ], "remove": [ { "name": "ReadExif" } ] }, "mediaEngines": { "addOrUpdate": [ "Xmp" ], "remove": [ "Exif", "Text" ] }, "previewFormat": "None", "previewRenderWebControls": { "addOrUpdate": [ "Adam.AudioPreviewPlayer" ], "remove": [ "Adam.PdfPreviewPlayer" ] }, "previewRequired": false, "keepDocumentDimensions": false, "allowOrderResizeSource": false, "supportsWatermarking": false, "registeredFields": { "remove": [ "c2ed2f3e-a145-44c0-8477-a82400d1f8cd" ] }, "registeredFieldGroups": { "remove": [ "40cd3ee8-08e5-4c52-8ec8-50a372e4de1c" ] }, "preferredExtension": false, "tag": "some tag" } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "delete": { "tags": [ "File type" ], "summary": "Delete the specified file type", "description": "### Examples\n\nDeleting a file type\n\n```http\nDELETE /filetype/6750869d69e64b6c86b4a7f900898bb4\n```", "operationId": "deleteFiletypeByFileTypeId", "parameters": [ { "name": "fileTypeId", "in": "path", "description": "id of the file type", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/filetypes": { "get": { "tags": [ "File type" ], "summary": "Read a collection of file types", "description": "### Examples\n\nSearching for file types (HTTP headers)\n\n```http\nGET /filetypes\naccept: application/hal+json\nfilter: ModifiedOn in today\nsort: createdon\npage: 1\npageSize: 20\n```\n\nSearching for file types (query string parameters)\n\n```http\nGET /filetypes?filter=ModifiedOn+in+today&sort=createdon&page=1&pagesize=10\n```\n\nSearching for file types (headers + query string combined)\n\n```http\nGET /filetypes?filter=ModifiedOn+in+today&sort=createdon\npage: 1\npageSize: 20\n```", "operationId": "getFiletypes", "parameters": [ { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "A filter expression restricting which items are returned, e.g. \"ModifiedOn in today\". Omit to return all items the caller may see. The query parameter is the canonical location for this filter; the same value may alternatively be sent as a same-named request header.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "The property to sort by, optionally suffixed to control direction, e.g. \"createdOn\". Omit for the endpoint's default order. May also be sent as a same-named request header.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "1-based page number, used together with \"pageSize\". Defaults to the first page. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Number of items per page, used together with \"page\". Too high values will be capped. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of items to skip, used together with \"take\" as an alternative to \"page\"/\"pageSize\". May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "take", "in": "query", "description": "Number of items to return, used together with \"skip\" as an alternative to \"page\"/\"pageSize\". Too high values will be capped. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/FileTypeResource" } }, "page": { "type": [ "null", "integer" ] }, "pageSize": { "type": [ "null", "integer" ] }, "totalCount": { "type": "integer", "format": "int64" } }, "description": "A paged/collection response envelope." } }, "application/hal+json": { "schema": { "required": [ "_links" ], "type": "object", "properties": { "_links": { "type": "object", "properties": { "self": { "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/FileTypeResource" } }, "page": { "type": [ "null", "integer" ] }, "pageSize": { "type": [ "null", "integer" ] }, "totalCount": { "type": "integer", "format": "int64" } }, "description": "A paged/collection response envelope." } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "post": { "tags": [ "File type" ], "summary": "Create a new file type", "operationId": "createFiletypes", "parameters": [ { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileTypeCreateCommand" }, "example": { "name": "filetype name", "kind": "knd", "extension": "ext", "mimeType": "application/octet-stream", "thumbnail": "ZGJjZWE1ZDRkMTM4NDRiZDhkMThhODI3MDA3ZmY3Y2M=", "icon": "ZTFlOGRhOWQxM2Y5NGE0MDg1ZDVhODI3MDA4MDEwMjM=", "labels": [ { "languageId": "c2bd4f9b-bb95-4bcb-80c3-1e924c9c26dc", "value": "file type" } ], "isCatalogable": true, "engineFormat": "ef", "catalogActions": { "addOrUpdate": [ { "name": "ReadXmp", "isCritical": true }, { "name": "ReadExif", "isCritical": false } ] }, "mediaEngines": { "addOrUpdate": [ "Exif", "Text" ] }, "previewFormat": "Jpg", "previewRenderWebControls": { "addOrUpdate": [ "Adam.PdfPreviewPlayer" ] }, "previewRequired": true, "keepDocumentDimensions": true, "allowOrderResizeSource": true, "supportsWatermarking": true, "registeredFields": { "addOrUpdate": [ "c2ed2f3e-a145-44c0-8477-a82400d1f8cd" ] }, "registeredFieldGroups": { "addOrUpdate": [ "40cd3ee8-08e5-4c52-8ec8-50a372e4de1c" ] }, "preferredExtension": false, "tag": "some tag" } } }, "required": true }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatedResourceId" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/filetype/{fileTypeId}/image/icon": { "get": { "tags": [ "File type" ], "summary": "Read the icon of the filetype", "operationId": "getFiletypeImageIconByFileTypeId", "parameters": [ { "name": "fileTypeId", "in": "path", "description": "id of the filetype", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImageResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/filetype/{fileTypeId}/image/thumbnail": { "get": { "tags": [ "File type" ], "summary": "Read the thumbnail of the filepreview of a filetype", "operationId": "getFiletypeImageThumbnailByFileTypeId", "parameters": [ { "name": "fileTypeId", "in": "path", "description": "id of the filetype", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImageResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/fileversion/{fileVersionId}": { "get": { "tags": [ "File version" ], "summary": "Read a file version", "operationId": "getFileversionByFileVersionId", "parameters": [ { "name": "fileVersionId", "in": "path", "description": "id of the file version", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileVersionResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/fileversion/{fileVersionId}/CheckResult": { "get": { "tags": [ "File version" ], "summary": "Read the latest file version check result for a specific check type", "description": "### Examples\n\nFindings are automatically included in the response.\n\n```http\nGET /fileversion/3A2CABD571C849A18F47B353013E3CD4/CheckResult?CheckId=4e0abe1380084b849ee0b35000da4940\naccept: application/hal+json\n```", "operationId": "getFileversionCheckResultByFileVersionId", "parameters": [ { "name": "fileVersionId", "in": "path", "description": "id of the file version", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "checkId", "in": "query", "description": "id of the check type (query parameter)", "schema": { "type": [ "null", "string" ], "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileVersionCheckResultResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/fileversion/{fileVersionId}/CheckResults": { "get": { "tags": [ "File version" ], "summary": "Read all file version check results for a file version", "description": "### Examples\n\nReading all file version check results\n\n```http\nGET /fileversion/3A2CABD571C849A18F47B353013E3CD4/CheckResults\naccept: application/hal+json\n```", "operationId": "getFileversionCheckResultsByFileVersionId", "parameters": [ { "name": "fileVersionId", "in": "path", "description": "id of the file version", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "title": "File version check result collection resource", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/FileVersionCheckResultResource" }, "description": "A collection of resource items." } }, "description": "Representation of a File Version Check Result Collection" } }, "application/hal+json": { "schema": { "required": [ "_links" ], "$ref": "#/components/schemas/FileVersionCheckResultCollectionResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "post": { "tags": [ "File version" ], "summary": "Create a new file version check result", "description": "### Examples\n\nCreating a file version check result\n\nThe CreatedBy field is automatically set from the authenticated user context for security.\n\nSee the `Creating a file version check result (json)` and `Creating a file version check result (hal+json)` response examples in the responses panel.\n\n```http\nPOST /fileversion/3A2CABD571C849A18F47B353013E3CD4/CheckResults\ncontent-type: application/json\naccept: application/hal+json\n```", "operationId": "createFileversionCheckResultsByFileVersionId", "parameters": [ { "name": "fileVersionId", "in": "path", "description": "id of the file version", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateFileVersionCheckResultCommand" } } }, "required": true }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatedResourceId" }, "examples": { "creating-a-file-version-check-result": { "summary": "Creating a file version check result (json)", "value": { "checkId": "4e0abe1380084b849ee0b35000da4940", "outcome": "fail", "description": "Security scan completed with issues found" } }, "creating-a-file-version-check-result-2": { "summary": "Creating a file version check result (hal+json)", "value": { "_links": { "self": { "href": "/fileversion/3A2CABD571C849A18F47B353013E3CD4/CheckResult/23ba861e6dee4bb9b71c9ee330fd4744" } }, "id": "23ba861e6dee4bb9b71c9ee330fd4744", "fileVersionId": "3A2CABD571C849A18F47B353013E3CD4", "checkId": "4e0abe1380084b849ee0b35000da4940", "outcome": "fail", "description": "Security scan completed with issues found", "createdOn": "2024-01-15T12:00:00.000Z", "createdBy": "12345678-1234-1234-1234-123456789012" } } } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/fileversion/{fileVersionId}/additionalfiles": { "get": { "tags": [ "File version" ], "summary": "Read all additional files of a file version", "description": "### Examples\n\nFiltering for types\n\nAdd the header 'select-additionalfile-type' with the requested value. This value can be a single type, or a comma separated string of types.\n\nFiltering for purposes\n\nAdd the header 'select-additionalfile-purpose' with the requested value. This value can be a single purpose, eg 'Review', 'LowRes', or a comma separated string of purposes.\n\nFiltering for usages\n\nAdd the header 'select-additionalfile-usage' with the requested value. This value can be a single usage, or a comma separated string of usages.", "operationId": "getFileversionAdditionalfilesByFileVersionId", "parameters": [ { "name": "fileVersionId", "in": "path", "description": "id of the file version", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/CropResource" }, { "$ref": "#/components/schemas/TrimResource" }, { "$ref": "#/components/schemas/StillResource" }, { "$ref": "#/components/schemas/SpinsetResource" }, { "$ref": "#/components/schemas/ThreeDimensionalFileResource" }, { "$ref": "#/components/schemas/SubtitleResource" }, { "$ref": "#/components/schemas/ExternalFileResource" }, { "$ref": "#/components/schemas/CustomFileResource" }, { "$ref": "#/components/schemas/VideoPersonThumbnailResource" }, { "$ref": "#/components/schemas/AdditionalFileResource" } ] } } }, "description": "A paged/collection response envelope." } }, "application/hal+json": { "schema": { "required": [ "_links" ], "type": "object", "properties": { "_links": { "type": "object", "properties": { "self": { "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "items": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/CropResource" }, { "$ref": "#/components/schemas/TrimResource" }, { "$ref": "#/components/schemas/StillResource" }, { "$ref": "#/components/schemas/SpinsetResource" }, { "$ref": "#/components/schemas/ThreeDimensionalFileResource" }, { "$ref": "#/components/schemas/SubtitleResource" }, { "$ref": "#/components/schemas/ExternalFileResource" }, { "$ref": "#/components/schemas/CustomFileResource" }, { "$ref": "#/components/schemas/VideoPersonThumbnailResource" }, { "$ref": "#/components/schemas/AdditionalFileResource" } ] } } }, "description": "A paged/collection response envelope." } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/fileversion/{fileVersionId}/duplicateinfo": { "get": { "tags": [ "File version" ], "summary": "Read the full duplicate info for the file version", "operationId": "getFileversionDuplicateinfoByFileVersionId", "parameters": [ { "name": "fileVersionId", "in": "path", "description": "id of the file version", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileVersionDuplicateInfoNonResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/fileversion/{fileVersionId}/filepreviews": { "get": { "tags": [ "File version" ], "summary": "Read all previews of a fileversion", "operationId": "getFileversionFilepreviewsByFileVersionId", "parameters": [ { "name": "fileVersionId", "in": "path", "description": "id of the fileversion", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "$ref": "#/components/mediaTypes/ICollectionResourceOfFilePreviewResourceJson" }, "application/hal+json": { "$ref": "#/components/mediaTypes/ICollectionResourceOfFilePreviewResourceHal" } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/fileversion/{fileVersionId}/fileprocessactionlog": { "get": { "tags": [ "File version" ], "summary": "Read a collection of file process action log entries", "operationId": "getFileversionFileprocessactionlogByFileVersionId", "parameters": [ { "name": "fileVersionId", "in": "path", "description": "The ID of the file version for which logs need to be retrieved.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "$ref": "#/components/mediaTypes/ICollectionResourceOfFileProcessActionLogResourceJson" }, "application/hal+json": { "$ref": "#/components/mediaTypes/ICollectionResourceOfFileProcessActionLogResourceHal" } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/fileversion/{fileVersionId}/filetype": { "get": { "tags": [ "File version" ], "summary": "Read the file type for file version", "operationId": "getFileversionFiletypeByFileVersionId", "parameters": [ { "name": "fileVersionId", "in": "path", "description": "id of the file version", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileTypeResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/fileversion/{fileVersionId}/masterfilepreview": { "get": { "tags": [ "File version" ], "summary": "Read the master filepreview of a file version", "operationId": "getFileversionMasterfilepreviewByFileVersionId", "parameters": [ { "name": "fileVersionId", "in": "path", "description": "id of the fileversion", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilePreviewResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/fileversion/{fileVersionId}/permissions": { "get": { "tags": [ "File version" ], "summary": "Read the permissions on a file version", "operationId": "getFileversionPermissionsByFileVersionId", "parameters": [ { "name": "fileVersionId", "in": "path", "description": "id of the file version", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileVersionPermissionsResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/fileversion/{fileVersionId}/publiclinks": { "get": { "tags": [ "File version" ], "summary": "Read the public links for the file version", "operationId": "getFileversionPubliclinksByFileVersionId", "parameters": [ { "name": "fileVersionId", "in": "path", "description": "id of the file version", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "$ref": "#/components/mediaTypes/PublicLinkCollectionResourceJson" }, "application/hal+json": { "$ref": "#/components/mediaTypes/PublicLinkCollectionResourceHal" } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/fileversion/{fileVersionId}/renditions": { "get": { "tags": [ "File version" ], "summary": "Read all renditions of a file version", "operationId": "getFileversionRenditionsByFileVersionId", "parameters": [ { "name": "fileVersionId", "in": "path", "description": "id of the file version", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "$ref": "#/components/mediaTypes/RenditionCollectionResourceJson" }, "application/hal+json": { "$ref": "#/components/mediaTypes/RenditionCollectionResourceHal" } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/fileversion/{fileVersionId}/watermark": { "get": { "tags": [ "File version" ], "summary": "Read the watermark of a file version", "operationId": "getFileversionWatermarkByFileVersionId", "parameters": [ { "name": "fileVersionId", "in": "path", "description": "id of the file version", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WatermarkResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/fileversion/{fileVersionId}/compareInsights": { "post": { "tags": [ "File version" ], "summary": "Save AI file version compare insights for the file version", "operationId": "createFileversionCompareInsightsByFileVersionId", "parameters": [ { "name": "fileVersionId", "in": "path", "description": "The ID of the recent file version.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileVersionCompareInsightPayload" } } }, "required": true }, "responses": { "201": { "description": "Success" }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/fileversion/{fileVersionId}/CheckResult/{checkResultId}": { "get": { "tags": [ "File version" ], "summary": "Read a specific file version check result by its ID", "description": "### Examples\n\nUnlike GET /fileversion/{fileVersionId}/CheckResult, which returns the latest result for a given check type, this returns one specific result by its own ID.\n\n```http\nGET /fileversion/3A2CABD571C849A18F47B353013E3CD4/CheckResult/23ba861e6dee4bb9b71c9ee330fd4744\naccept: application/hal+json\n```", "operationId": "getFileversionCheckResultByFileVersionIdAndCheckResultId", "parameters": [ { "name": "fileVersionId", "in": "path", "description": "id of the file version", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "checkResultId", "in": "path", "description": "id of the check result", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileVersionCheckResultResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "put": { "tags": [ "File version" ], "summary": "Update a file version check result", "description": "### Examples\n\nUpdating a file version check result\n\nThere's no ModifiedBy field: only the original creator is tracked, not who last updated it.\n\n```http\nPUT /fileversion/3A2CABD571C849A18F47B353013E3CD4/CheckResult/23ba861e6dee4bb9b71c9ee330fd4744\ncontent-type: application/json\n```\n\n```json\n{\n\t\"outcome\": \"pass\",\n\t\"description\": \"Updated: Security scan completed successfully after fixes\"\n}\n```", "operationId": "updateFileversionCheckResultByFileVersionIdAndCheckResultId", "parameters": [ { "name": "fileVersionId", "in": "path", "description": "id of the file version", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "checkResultId", "in": "path", "description": "id of the check result", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateFileVersionCheckResultCommand" } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "delete": { "tags": [ "File version" ], "summary": "Delete a file version check result", "description": "### Examples\n\nDeleting a file version check result\n\n```http\nDELETE /fileversion/3A2CABD571C849A18F47B353013E3CD4/CheckResult/23ba861e6dee4bb9b71c9ee330fd4744\n```", "operationId": "deleteFileversionCheckResultByFileVersionIdAndCheckResultId", "parameters": [ { "name": "fileVersionId", "in": "path", "description": "id of the file version", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "checkResultId", "in": "path", "description": "id of the check result", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/fileversion/{fileVersionId}/image/preview": { "get": { "tags": [ "File version" ], "summary": "Read the preview of the filepreview of a fileversion", "operationId": "getFileversionImagePreviewByFileVersionId", "parameters": [ { "name": "fileVersionId", "in": "path", "description": "id of the fileversion", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImageResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/fileversion/{fileVersionId}/image/thumbnail": { "get": { "tags": [ "File version" ], "summary": "Read the thumbnail of the filepreview of a fileversion", "operationId": "getFileversionImageThumbnailByFileVersionId", "parameters": [ { "name": "fileVersionId", "in": "path", "description": "id of the fileversion", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImageResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/fileversion/{fileVersionId}/linkedversions/{linkedVersionType}": { "get": { "tags": [ "File version" ], "summary": "Read the publications a file version is used in", "operationId": "getFileversionLinkedversionsByFileVersionIdAndLinkedVersionType", "parameters": [ { "name": "fileVersionId", "in": "path", "description": "id of the file version", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "linkedVersionType", "in": "path", "description": "The type of link", "required": true, "schema": { "enum": [ "Contains", "UsedIn" ], "type": "string" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "1-based page number, used together with \"pageSize\". Defaults to the first page. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Number of items per page, used together with \"page\". Too high values will be capped. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of items to skip, used together with \"take\" as an alternative to \"page\"/\"pageSize\". May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "take", "in": "query", "description": "Number of items to return, used together with \"skip\" as an alternative to \"page\"/\"pageSize\". Too high values will be capped. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "$ref": "#/components/mediaTypes/IPagedCollectionResourceOfNonResourcesOfLinkedVersionInfoNonResourceJson" }, "application/hal+json": { "$ref": "#/components/mediaTypes/IPagedCollectionResourceOfNonResourcesOfLinkedVersionInfoNonResourceHal" } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/fileversion/{fileVersionId}/CheckResult/{checkResultId}/Findings": { "get": { "tags": [ "File version" ], "summary": "Read all file version check result findings for a check result", "description": "### Examples\n\nReading all file version check result findings\n\n```http\nGET /fileversion/3A2CABD571C849A18F47B353013E3CD4/CheckResult/23ba861e6dee4bb9b71c9ee330fd4744/Findings\naccept: application/hal+json\n```", "operationId": "getFileversionCheckResultFindingsByFileVersionIdAndCheckResultId", "parameters": [ { "name": "fileVersionId", "in": "path", "description": "id of the file version", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "checkResultId", "in": "path", "description": "id of the check result", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "title": "File version check result finding collection resource", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/FileVersionCheckResultFindingResource" }, "description": "A collection of resource items." } }, "description": "Representation of a File Version Check Result Finding Collection" } }, "application/hal+json": { "schema": { "required": [ "_links" ], "$ref": "#/components/schemas/FileVersionCheckResultFindingCollectionResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "post": { "tags": [ "File version" ], "summary": "Create a new file version check result finding", "description": "### Examples\n\nCreating a file version check result finding\n\nFindings don't track who created or last modified them.\n\n```http\nPOST /fileversion/3A2CABD571C849A18F47B353013E3CD4/CheckResult/23ba861e6dee4bb9b71c9ee330fd4744/Findings\ncontent-type: application/json\naccept: application/hal+json\n```", "operationId": "createFileversionCheckResultFindingsByFileVersionIdAndCheckResultId", "parameters": [ { "name": "fileVersionId", "in": "path", "description": "id of the file version", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "checkResultId", "in": "path", "description": "id of the check result", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateFileVersionCheckResultFindingCommand" } } }, "required": true }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileVersionCheckResultFindingResource" }, "example": { "occurrence": 1, "finding": "Potential SQL injection vulnerability detected", "explanation": "The query parameter is not properly sanitized", "recommendation": "Use parameterized queries", "additionalData": "{\"line\": 42, \"severity\": \"high\"}", "outcome": "fail" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/fileversion/{fileVersionId}/CheckResult/{checkResultId}/Findings/{occurrence}": { "get": { "tags": [ "File version" ], "summary": "Read a file version check result finding", "description": "### Examples\n\nReading a file version check result finding\n\n```http\nGET /fileversion/3A2CABD571C849A18F47B353013E3CD4/CheckResult/23ba861e6dee4bb9b71c9ee330fd4744/Findings/1\naccept: application/hal+json\n```", "operationId": "getFileversionCheckResultFindingsByFileVersionIdAndCheckResultIdAndOccurrence", "parameters": [ { "name": "fileVersionId", "in": "path", "description": "id of the file version", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "checkResultId", "in": "path", "description": "id of the check result", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "occurrence", "in": "path", "description": "occurrence of the finding", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileVersionCheckResultFindingResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "put": { "tags": [ "File version" ], "summary": "Update a file version check result finding", "description": "### Examples\n\nUpdating a file version check result finding\n\nThere's no ModifiedBy field: who last updated a finding isn't tracked.\n\n```http\nPUT /fileversion/3A2CABD571C849A18F47B353013E3CD4/CheckResult/23ba861e6dee4bb9b71c9ee330fd4744/Findings/1\ncontent-type: application/json\n```\n\n```json\n{\n\t\"finding\": \"Updated: SQL injection vulnerability confirmed\",\n\t\"explanation\": \"The query parameter is not properly sanitized - confirmed by security team\",\n\t\"recommendation\": \"Use parameterized queries and input validation\",\n\t\"additionalData\": \"{\\\"line\\\": 42, \\\"severity\\\": \\\"critical\\\", \\\"cve\\\": \\\"CVE-2024-1234\\\"}\",\n\t\"outcome\": \"fail\"\n}\n```", "operationId": "updateFileversionCheckResultFindingsByFileVersionIdAndCheckResultIdAndOccurrence", "parameters": [ { "name": "fileVersionId", "in": "path", "description": "id of the file version", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "checkResultId", "in": "path", "description": "id of the check result", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "occurrence", "in": "path", "description": "occurrence of the finding", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateFileVersionCheckResultFindingCommand" } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "delete": { "tags": [ "File version" ], "summary": "Delete a file version check result finding", "description": "### Examples\n\nDeleting a file version check result finding\n\n```http\nDELETE /fileversion/3A2CABD571C849A18F47B353013E3CD4/CheckResult/23ba861e6dee4bb9b71c9ee330fd4744/Findings/1\n```", "operationId": "deleteFileversionCheckResultFindingsByFileVersionIdAndCheckResultIdAndOccurrence", "parameters": [ { "name": "fileVersionId", "in": "path", "description": "id of the file version", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "checkResultId", "in": "path", "description": "id of the check result", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "occurrence", "in": "path", "description": "occurrence of the finding", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/": { "get": { "tags": [ "Home" ], "summary": "Root of the API", "operationId": "get", "parameters": [ { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HomeResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/imageoverlay/{imageOverlayId}": { "get": { "tags": [ "Image overlay" ], "summary": "Read an image overlay", "operationId": "getImageoverlayByImageOverlayId", "parameters": [ { "name": "imageOverlayId", "in": "path", "description": "The id of the image overlay.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImageOverlayResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/imageoverlays": { "get": { "tags": [ "Image overlay" ], "summary": "Read a collection of image overlays", "operationId": "getImageoverlays", "parameters": [ { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "A filter expression restricting which items are returned, e.g. \"ModifiedOn in today\". Omit to return all items the caller may see. The query parameter is the canonical location for this filter; the same value may alternatively be sent as a same-named request header.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "The property to sort by, optionally suffixed to control direction, e.g. \"createdOn\". Omit for the endpoint's default order. May also be sent as a same-named request header.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "1-based page number, used together with \"pageSize\". Defaults to the first page. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Number of items per page, used together with \"page\". Too high values will be capped. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of items to skip, used together with \"take\" as an alternative to \"page\"/\"pageSize\". May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "take", "in": "query", "description": "Number of items to return, used together with \"skip\" as an alternative to \"page\"/\"pageSize\". Too high values will be capped. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "$ref": "#/components/mediaTypes/IPagedCollectionResourceOfImageOverlayResourceJson" }, "application/hal+json": { "$ref": "#/components/mediaTypes/IPagedCollectionResourceOfImageOverlayResourceHal" } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "post": { "tags": [ "Image overlay" ], "summary": "Create a new image overlay", "operationId": "createImageoverlays", "parameters": [ { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImageOverlayCreateCommand" } } }, "required": true }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatedResourceIdOfInt32" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/imageoverlay/{imageOverlayId}/classifications": { "get": { "tags": [ "Image overlay" ], "summary": "Read all classifications of an image overlay", "operationId": "getImageoverlayClassificationsByImageOverlayId", "parameters": [ { "name": "imageOverlayId", "in": "path", "description": "id of the image overlay", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "The property to sort by, optionally suffixed to control direction, e.g. \"createdOn\". Omit for the endpoint's default order. May also be sent as a same-named request header.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "1-based page number, used together with \"pageSize\". Defaults to the first page. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Number of items per page, used together with \"page\". Too high values will be capped. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of items to skip, used together with \"take\" as an alternative to \"page\"/\"pageSize\". May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "take", "in": "query", "description": "Number of items to return, used together with \"skip\" as an alternative to \"page\"/\"pageSize\". Too high values will be capped. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "$ref": "#/components/mediaTypes/ImageOverlayClassificationCollectionResourceJson" }, "application/hal+json": { "$ref": "#/components/mediaTypes/ImageOverlayClassificationCollectionResourceHal" } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/imageoverlay/{imageOverlayId}/usergroups": { "get": { "tags": [ "Image overlay" ], "summary": "Read all user groups of an image overlay", "operationId": "getImageoverlayUsergroupsByImageOverlayId", "parameters": [ { "name": "imageOverlayId", "in": "path", "description": "id of the image overlay", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "The property to sort by, optionally suffixed to control direction, e.g. \"createdOn\". Omit for the endpoint's default order. May also be sent as a same-named request header.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "1-based page number, used together with \"pageSize\". Defaults to the first page. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Number of items per page, used together with \"page\". Too high values will be capped. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of items to skip, used together with \"take\" as an alternative to \"page\"/\"pageSize\". May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "take", "in": "query", "description": "Number of items to return, used together with \"skip\" as an alternative to \"page\"/\"pageSize\". Too high values will be capped. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "$ref": "#/components/mediaTypes/ImageOverlayUserGroupCollectionResourceJson" }, "application/hal+json": { "$ref": "#/components/mediaTypes/ImageOverlayUserGroupCollectionResourceHal" } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/info": { "get": { "tags": [ "Info" ], "summary": "Read the currently active DAM version", "operationId": "getInfo", "parameters": [ { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ReleaseResource" }, { "$ref": "#/components/schemas/InfoResource" } ] } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/language/{languageId}": { "get": { "tags": [ "Language" ], "summary": "Read a language", "operationId": "getLanguageByLanguageId", "parameters": [ { "name": "languageId", "in": "path", "description": "id of the language", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LanguageResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "put": { "tags": [ "Language" ], "summary": "Edit an existing language", "operationId": "updateLanguageByLanguageId", "parameters": [ { "name": "languageId", "in": "path", "description": "id of the language", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LanguageEditCommand" }, "example": { "name": "Language Name", "culture": "nl-BE", "enabledForFields": false, "tag": "xml" } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "delete": { "tags": [ "Language" ], "summary": "Delete the specified language", "description": "### Examples\n\nDeleting a language\n\n```http\nDELETE /language/c584888369ab4f049f367ea9f19137e3\n```", "operationId": "deleteLanguageByLanguageId", "parameters": [ { "name": "languageId", "in": "path", "description": "id of the language", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/languages": { "get": { "tags": [ "Language" ], "summary": "Read a collection of languages", "description": "### Examples\n\nSearching for languages. (HTTP headers)\n\n```http\nGET /languages\naccept: application/hal+json\nfilter: Name=Dutch\nsort: createdon\npage: 1\npageSize: 20\n```\n\nSearching for languages. (query string parameters)\n\n```http\nGET /languages?filter=Name=Dutch&sort=createdon&page=1&pagesize=10\n```\n\nSearching for languages. (headers + query string combined)\n\n```http\nGET /languages?filter=Name=Dutch&sort=createdon\npage: 1\npageSize: 20\n```", "operationId": "getLanguages", "parameters": [ { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "A filter expression restricting which items are returned, e.g. \"ModifiedOn in today\". Omit to return all items the caller may see. The query parameter is the canonical location for this filter; the same value may alternatively be sent as a same-named request header.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "The property to sort by, optionally suffixed to control direction, e.g. \"createdOn\". Omit for the endpoint's default order. May also be sent as a same-named request header.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "1-based page number, used together with \"pageSize\". Defaults to the first page. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Number of items per page, used together with \"page\". Too high values will be capped. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of items to skip, used together with \"take\" as an alternative to \"page\"/\"pageSize\". May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "take", "in": "query", "description": "Number of items to return, used together with \"skip\" as an alternative to \"page\"/\"pageSize\". Too high values will be capped. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/LanguageResource" } }, "page": { "type": [ "null", "integer" ] }, "pageSize": { "type": [ "null", "integer" ] }, "totalCount": { "type": "integer", "format": "int64" } }, "description": "A paged/collection response envelope." } }, "application/hal+json": { "schema": { "required": [ "_links" ], "type": "object", "properties": { "_links": { "type": "object", "properties": { "self": { "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/LanguageResource" } }, "page": { "type": [ "null", "integer" ] }, "pageSize": { "type": [ "null", "integer" ] }, "totalCount": { "type": "integer", "format": "int64" } }, "description": "A paged/collection response envelope." } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "post": { "tags": [ "Language" ], "summary": "Create a new language", "operationId": "createLanguages", "parameters": [ { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LanguageCreateCommand" }, "example": { "name": "New Language name", "culture": "uk-UA", "enabledForFields": true, "tag": "xml" } } }, "required": true }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatedResourceId" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/language/{languageId}/image": { "get": { "tags": [ "Language" ], "summary": "Read the image of a language", "operationId": "getLanguageImageByLanguageId", "parameters": [ { "name": "languageId", "in": "path", "description": "id of the language", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImageResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/language/{languageId}/synonyms": { "get": { "tags": [ "Language" ], "summary": "Export the list of synonyms for this language", "description": "### Examples\n\nExporting synonyms\n\nThis will return the synonyms as a solr formatted file. A **Content-Disposition** header will be added to the download.\n\n```http\nGET /language/1b35bde3-c0d0-4eaa-8cdc-0afc662e583d/synonyms\n```", "operationId": "getLanguageSynonymsByLanguageId", "parameters": [ { "name": "languageId", "in": "path", "description": "id of the language", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "put": { "tags": [ "Language" ], "summary": "Import the list of synonyms for this language", "operationId": "updateLanguageSynonymsByLanguageId", "parameters": [ { "name": "languageId", "in": "path", "description": "id of the language", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/maintenancejob/{maintenanceJobId}": { "get": { "tags": [ "Maintenance job" ], "summary": "Read a maintenance job", "description": "### Examples\n\nReading a maintenance job without embedded targets\n\nIn case of **hal+json**, all subresources (targets) are represented as links to these resources.\n\nIn case of **json**, all subresources (targets) are returned as null values.\n\nSee the `Reading a maintenance job without embedded targets (hal+json)` and `Reading a maintenance job without embedded targets (json)` response examples in the responses panel.\n\n```http\nGET /maintenancejob/b6d2400e-ffce-489b-9e08-7324c9378206\naccept: application/hal+json\n```\n\n```http\nGET /maintenancejob/b6d2400e-ffce-489b-9e08-7324c9378206\naccept: application/json\n```\n\nReading a maintenance job with embedded targets\n\nThe **select-maintenancejob: targets** header embeds the targets collection directly in the response instead of just linking to it.\n\n```http\nGET /maintenancejob/b6d2400e-ffce-489b-9e08-7324c9378206\naccept: application/hal+json\nselect-maintenancejob: targets\n```", "operationId": "getMaintenancejobByMaintenanceJobId", "parameters": [ { "name": "maintenanceJobId", "in": "path", "description": "id of the maintenance job", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" }, "examples": { "read": { "value": "application/hal+json" }, "read-2": { "value": "application/json" }, "read-select": { "value": "application/hal+json" } } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/MaintenanceJobResource" }, { "$ref": "#/components/schemas/ExportAuditMaintenanceJobResource" } ] }, "examples": { "read": { "summary": "Reading a maintenance job without embedded targets (hal+json)", "value": { "_links": { "targets": { "href": "/maintenancejob/11489c63d7ac42da916ba4e901008807/targets", "select-key": "targets" }, "self": { "href": "/maintenancejob/11489c63-d7ac-42da-916b-a4e901008807" } }, "actions": [ { "label": "Resave record" } ], "createdBy": "fa286193ddbf44299d2ea2390e2a8b99", "createdOn": "2015-08-03T15:31:43.633", "creatorEmail": "frank.tremens@adamsoftware.net", "disableNotification": false, "earliestStartDate": "2015-08-20T22:00:00Z", "executionTime": "00:00:00", "id": "11489c63d7ac42da916ba4e901008807", "priority": "Medium", "startedOn": null, "status": "Pending" } }, "read-2": { "summary": "Reading a maintenance job without embedded targets (json)", "value": { "targets": null, "actions": [ { "label": "Resave record" } ], "createdBy": "fa286193ddbf44299d2ea2390e2a8b99", "createdOn": "2015-08-03T15:31:43.633", "creatorEmail": "frank.tremens@adamsoftware.net", "disableNotification": false, "earliestStartDate": "2015-08-20T22:00:00Z", "executionTime": "00:00:00", "id": "11489c63d7ac42da916ba4e901008807", "priority": "Medium", "startedOn": null, "status": "Pending" } }, "read-select": { "summary": "Reading a maintenance job with embedded targets", "value": { "_links": { "self": { "href": "/maintenancejob/11489c63-d7ac-42da-916b-a4e901008807" } }, "actions": [ { "label": "Resave record", "impact": 40 } ], "createdBy": "fa286193ddbf44299d2ea2390e2a8b99", "createdOn": "2015-08-03T15:31:43.633", "creatorEmail": "frank.tremens@adamsoftware.net", "disableNotification": false, "earliestStartDate": "2015-08-20T22:00:00Z", "executionTime": "00:00:00", "id": "11489c63d7ac42da916ba4e901008807", "priority": "Medium", "startedOn": null, "status": "Pending", "_embedded": { "targets": { "_links": { "self": { "href": "/maintenancejob/11489c63d7ac42da916ba4e901008807/targets" } }, "items": [ { "id": "bd4855e731724b67835c38fa311f11d0", "attempt": 1, "errorDetails": "", "executionTime": "00:00:00", "forceRetry": false, "message": "", "status": "Pending", "tag": null }, { "id": "d3299f7df4724895914bc5bcdab14805", "attempt": 1, "errorDetails": "", "executionTime": "00:00:00", "forceRetry": false, "message": "", "status": "Pending", "tag": null }, { "id": "f107d016115b41848b7fc10a8d73293b", "attempt": 1, "errorDetails": "", "executionTime": "00:00:00", "forceRetry": false, "message": "", "status": "Pending", "tag": null } ] } } } } } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/maintenancejobs": { "get": { "tags": [ "Maintenance job" ], "summary": "Read all maintenance jobs", "description": "### Examples\n\nSearching for maintenance jobs (HTTP headers)\n\n```http\nGET /maintenancejobs\naccept: application/hal+json\nfilter: CreatedOn in today\nsort: createdon\npage: 1\npageSize: 20\n```\n\nSearching for maintenance jobs (query string parameters)\n\n```http\nGET /maintenancejobs?filter=CreatedOn+in+today&sort=createdon&page=1&pagesize=10\n```\n\nSearching for maintenance jobs (headers + query string combined)\n\n```http\nGET /maintenancejobs?filter=CreatedOn+in+today&sort=createdon\npage: 1\npageSize: 20\n```", "operationId": "getMaintenancejobs", "parameters": [ { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "A filter expression restricting which items are returned, e.g. \"ModifiedOn in today\". Omit to return all items the caller may see. The query parameter is the canonical location for this filter; the same value may alternatively be sent as a same-named request header.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "The property to sort by, optionally suffixed to control direction, e.g. \"createdOn\". Omit for the endpoint's default order. May also be sent as a same-named request header.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "1-based page number, used together with \"pageSize\". Defaults to the first page. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Number of items per page, used together with \"page\". Too high values will be capped. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of items to skip, used together with \"take\" as an alternative to \"page\"/\"pageSize\". May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "take", "in": "query", "description": "Number of items to return, used together with \"skip\" as an alternative to \"page\"/\"pageSize\". Too high values will be capped. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "title": "Maintenance job paged collection resource", "type": "object", "properties": { "pageNumber": { "type": [ "null", "integer" ], "description": "The current page of this paged collection.", "format": "int32" }, "pageSize": { "type": [ "null", "integer" ], "description": "The current page size of this paged collection.", "format": "int32" }, "skip": { "type": [ "null", "integer" ], "description": "The current skip size of this paged collection.", "format": "int32" }, "take": { "type": [ "null", "integer" ], "description": "The current take size of this paged collection.", "format": "int32" }, "totalCount": { "type": "integer", "description": "The total count of items in this paged collection, not just on the current page.", "format": "int64" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/MaintenanceJobResource" }, "description": "One page of this paged collection, which is a subcollection of the complete collection." } }, "description": "Representation of a paged collection of maintenance jobs" } }, "application/hal+json": { "schema": { "required": [ "_links" ], "$ref": "#/components/schemas/MaintenanceJobPagedCollectionResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "post": { "tags": [ "Maintenance job" ], "summary": "Create a new maintenance job", "operationId": "createMaintenancejobs", "parameters": [ { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/RecordMaintenanceJobCommand" }, { "$ref": "#/components/schemas/BulkRecordMaintenanceJobCommand" }, { "$ref": "#/components/schemas/BulkCollectionMaintenanceJobCommand" }, { "$ref": "#/components/schemas/ClassificationMaintenanceJobCommand" }, { "$ref": "#/components/schemas/ExportAuditMaintenanceJobCommand" }, { "$ref": "#/components/schemas/AcceptDownloadOrderAgreementJobCommand" }, { "$ref": "#/components/schemas/ExportContentItemsListMaintenanceJobCommand" } ], "discriminator": { "propertyName": "type", "mapping": { "Record": "#/components/schemas/RecordMaintenanceJobCommand", "BulkRecord": "#/components/schemas/BulkRecordMaintenanceJobCommand", "BulkCollection": "#/components/schemas/BulkCollectionMaintenanceJobCommand", "Classification": "#/components/schemas/ClassificationMaintenanceJobCommand", "ExportAuditTrail": "#/components/schemas/ExportAuditMaintenanceJobCommand", "AcceptDownloadOrderAgreement": "#/components/schemas/AcceptDownloadOrderAgreementJobCommand", "ExportContentItemsList": "#/components/schemas/ExportContentItemsListMaintenanceJobCommand" } } }, "examples": { "create-record": { "summary": "Creating a new maintenance job", "value": { "type": "record", "priority": "Medium", "creatorEmail": "frank.tremens@adamsoftware.net", "disableNotification": "true", "earliestStartDate": "2015-08-01T10:00:00Z", "targets": [ { "recordId": "bbf68a95b3f547e4acb9a3cd0069b702", "forceRetry": "true", "tag": "some tag" }, { "recordId": "8735a5a3e75a4bc0a2a1a3cd0069b669" }, { "recordId": "b2fcb9c50d264ac19a6ba3cd0069b785", "tag": "some tag" } ], "actions": [ { "action": "classifyRecord", "label": "a dummy label", "description": "a dummy description", "parameters": { "classificationId": "209d7ede48004a008885a3cd006b8b8c" } } ] } }, "create-bulk-collection-change-owner": { "summary": "Creating a bulk collection maintenance job to change collection owners", "value": { "type": "BulkCollection", "priority": "Medium", "creatorEmail": "admin@example.com", "disableNotification": "false", "earliestStartDate": "2015-08-01T10:00:00Z", "targets": [ { "collectionIds": [ "11111111-1111-1111-1111-111111111111", "22222222-2222-2222-2222-222222222222", "33333333-3333-3333-3333-333333333333" ] } ], "actions": [ { "action": "ChangeCollectionOwner", "label": "Change collection owner", "description": "Reassign ownership of collections to new user", "parameters": { "newOwnerId": "44444444-4444-4444-4444-444444444444" } } ] } }, "create-bulk-collection-change-status": { "summary": "Creating a bulk collection maintenance job to change status of collections", "value": { "type": "BulkCollection", "priority": "Medium", "creatorEmail": "admin@example.com", "disableNotification": "false", "targets": [ { "collectionIds": [ "11111111-1111-1111-1111-111111111111", "22222222-2222-2222-2222-222222222222" ] } ], "actions": [ { "action": "ChangeCollectionStatus", "label": "Change status of collections", "description": "Delete or archive the specified collections", "parameters": { "newStatus": "Delete" } } ] } }, "create-bulk-record": { "summary": "Creating a bulk record maintenance job to force records dirty", "value": { "type": "BulkRecord", "priority": "Medium", "creatorEmail": "admin@example.com", "targets": [ { "recordIds": [ "11111111-1111-1111-1111-111111111111", "22222222-2222-2222-2222-222222222222" ] } ], "actions": [ { "action": "ForceDirty" } ] } }, "create-classification": { "summary": "Creating a classification maintenance job", "value": { "type": "Classification", "priority": "Medium", "creatorEmail": "admin@example.com", "targets": [ { "classificationId": "30b92c87-7b43-4a84-89eb-a81300fae78d" } ], "actions": [ { "action": "ClassificationSave" } ] } }, "create-export-audit-trail": { "summary": "Creating a job to export a record's audit trail", "value": { "type": "ExportAuditTrail", "priority": "Medium", "creatorEmail": "admin@example.com", "dateFrom": "2026-01-01T00:00:00Z", "dateTo": "2026-02-01T00:00:00Z", "targets": [ { "recordId": "bbf68a95b3f547e4acb9a3cd0069b702" } ] } }, "create-accept-download-order-agreement": { "summary": "Creating a job to accept a download order agreement", "value": { "type": "AcceptDownloadOrderAgreement", "priority": "Medium", "creatorEmail": "admin@example.com", "targets": [ { "orderId": "5c369ac6b5c4e19b2c4bf826f74ab6d6", "userId": "fa286193ddbf44299d2ea2390e2a8b99", "acceptanceDate": "2026-02-10T09:00:00Z", "downloadAgreementContentId": 12345 } ] } }, "create-export-content-items-list": { "summary": "Creating a job to export a content items list", "value": { "type": "ExportContentItemsList", "priority": "Medium", "creatorEmail": "admin@example.com", "columns": [ { "fieldName": "Title", "localizedHeader": "Title", "kind": 0 }, { "fieldName": "MasterFile", "localizedHeader": "Preview", "kind": 3 } ], "contentLanguage": "en-US", "targets": [ { "recordId": "bbf68a95b3f547e4acb9a3cd0069b702" } ] } }, "create-renditions": { "summary": "Creating a record maintenance job to create renditions", "value": { "type": "record", "priority": "Medium", "creatorEmail": "admin@example.com", "targets": [ { "recordId": "bbf68a95b3f547e4acb9a3cd0069b702" } ], "actions": [ { "action": "CreateRenditions", "parameters": { "presets": [ "Rendition1" ] } } ] } } } } }, "required": true }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatedResourceId" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/maintenancejob/{maintenanceJobId}/targets": { "get": { "tags": [ "Maintenance job" ], "summary": "Read all targets of a maintenance job", "operationId": "getMaintenancejobTargetsByMaintenanceJobId", "parameters": [ { "name": "maintenanceJobId", "in": "path", "description": "id of the maintenance job", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "$ref": "#/components/mediaTypes/MaintenanceTargetCollectionResourceJson" }, "application/hal+json": { "$ref": "#/components/mediaTypes/MaintenanceTargetCollectionResourceHal" } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/maintenancejob/{maintenanceJobId}/target/{maintenanceTargetId}": { "get": { "tags": [ "Maintenance job" ], "summary": "Read a maintenance target", "operationId": "getMaintenancejobTargetByMaintenanceJobIdAndMaintenanceTargetId", "parameters": [ { "name": "maintenanceJobId", "in": "path", "description": "id of the maintenance job", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "maintenanceTargetId", "in": "path", "description": "id of the maintenance target", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/RecordMaintenanceTargetResource" }, { "$ref": "#/components/schemas/ClassificationMaintenanceTargetResource" }, { "$ref": "#/components/schemas/RuleMaintenanceTargetResource" }, { "$ref": "#/components/schemas/ReportingMaintenanceTargetResource" }, { "$ref": "#/components/schemas/OrderTargetResource" } ] } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/order/{orderId}": { "get": { "tags": [ "Order" ], "summary": "Read an order", "operationId": "getOrderByOrderId", "parameters": [ { "name": "orderId", "in": "path", "description": "id of the order", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/AkamaiCdnOrderResource" }, { "$ref": "#/components/schemas/BrandTemplateOrderResource" }, { "$ref": "#/components/schemas/BrandTemplatePreprocessingOrderResource" }, { "$ref": "#/components/schemas/DownloadOrderResource" }, { "$ref": "#/components/schemas/EmailOrderResource" }, { "$ref": "#/components/schemas/FtpOrderResource" }, { "$ref": "#/components/schemas/FtpResortOrderResource" }, { "$ref": "#/components/schemas/PublicCdnOrderResource" }, { "$ref": "#/components/schemas/ShareDownloadLinkOrderResource" }, { "$ref": "#/components/schemas/DownloadContactSheetResource" } ], "discriminator": { "propertyName": "orderType", "mapping": { "akamaiCdn": "#/components/schemas/AkamaiCdnOrderResource", "brandTemplate": "#/components/schemas/BrandTemplateOrderResource", "brandTemplatePreprocessing": "#/components/schemas/BrandTemplatePreprocessingOrderResource", "download": "#/components/schemas/DownloadOrderResource", "email": "#/components/schemas/EmailOrderResource", "ftp": "#/components/schemas/FtpOrderResource", "ftpResort": "#/components/schemas/FtpResortOrderResource", "publicCdn": "#/components/schemas/PublicCdnOrderResource", "shareDownloadLink": "#/components/schemas/ShareDownloadLinkOrderResource", "contactsheet": "#/components/schemas/DownloadContactSheetResource" } } } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "put": { "tags": [ "Order" ], "summary": "Edit an existing order", "operationId": "updateOrderByOrderId", "parameters": [ { "name": "orderId", "in": "path", "description": "id of the order", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderEditCommand" } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/orders": { "get": { "tags": [ "Order" ], "summary": "Read a collection of orders", "operationId": "getOrders", "parameters": [ { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "A filter expression restricting which items are returned, e.g. \"ModifiedOn in today\". Omit to return all items the caller may see. The query parameter is the canonical location for this filter; the same value may alternatively be sent as a same-named request header.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "The property to sort by, optionally suffixed to control direction, e.g. \"createdOn\". Omit for the endpoint's default order. May also be sent as a same-named request header.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "1-based page number, used together with \"pageSize\". Defaults to the first page. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Number of items per page, used together with \"page\". Too high values will be capped. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of items to skip, used together with \"take\" as an alternative to \"page\"/\"pageSize\". May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "take", "in": "query", "description": "Number of items to return, used together with \"skip\" as an alternative to \"page\"/\"pageSize\". Too high values will be capped. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "$ref": "#/components/mediaTypes/OrderPagedCollectionResourceJson" }, "application/hal+json": { "$ref": "#/components/mediaTypes/OrderPagedCollectionResourceHal" } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "post": { "tags": [ "Order" ], "summary": "Create a new order", "description": "### Examples\n\nFollowing up on an order\n\nOnce the order has been created, a resource is returned containing the id and the status of the order.\n\nOrders will not always be processed immediately. They are processed by a service bus. The resource need be retrieved at a later time and a link to the delivered files will be available upon successfully processing the order. The user which will later retrieve the order must be assigned to the **ViewMaintenanceJobs** role in order to access this resource.\n\nA generated order can be retrieved directly in the following way:\n\n```http\nGET /order/94c217e4565f44d79beea4ba00a2fa97\n```", "operationId": "createOrders", "parameters": [ { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/DownloadOrderCreateCommand" }, { "$ref": "#/components/schemas/BrandTemplateOrderCreateCommand" }, { "$ref": "#/components/schemas/BrandTemplatePreprocessingOrderCreateCommand" }, { "$ref": "#/components/schemas/FtpOrderCreateCommand" }, { "$ref": "#/components/schemas/EmailOrderCreateCommand" }, { "$ref": "#/components/schemas/FtpResortOrderCreateCommand" }, { "$ref": "#/components/schemas/AkamaiCdnOrderCreateCommand" }, { "$ref": "#/components/schemas/PublicCdnOrderCreateCommand" }, { "$ref": "#/components/schemas/ShareDownloadLinkOrderCreateCommand" }, { "$ref": "#/components/schemas/PublicCdnAdaptiveStreamingOrderCreateCommand" } ], "discriminator": { "propertyName": "type", "mapping": { "Download": "#/components/schemas/DownloadOrderCreateCommand", "BrandTemplate": "#/components/schemas/BrandTemplateOrderCreateCommand", "BrandTemplatePreprocessing": "#/components/schemas/BrandTemplatePreprocessingOrderCreateCommand", "Ftp": "#/components/schemas/FtpOrderCreateCommand", "Email": "#/components/schemas/EmailOrderCreateCommand", "FtpResort": "#/components/schemas/FtpResortOrderCreateCommand", "AkamaiCdn": "#/components/schemas/AkamaiCdnOrderCreateCommand", "PublicCdn": "#/components/schemas/PublicCdnOrderCreateCommand", "ShareDownloadLink": "#/components/schemas/ShareDownloadLinkOrderCreateCommand", "PublicCdnAdaptiveStreaming": "#/components/schemas/PublicCdnAdaptiveStreamingOrderCreateCommand" } } }, "examples": { "add": { "summary": "Order targets and target actions", "value": { "type": "download", "creatorEmail": "frank.tremens@adamsoftware.net", "disableNotification": "true", "downloadsPageUrl": "http://localhost/Assets/Downloads", "notificationThresholdInSeconds": "0", "targets": [ { "recordId": "15e1090e37a34428a5efa3cd007c7807", "targetTypes": [ "MasterPreview", "MasterThumbnail" ], "assetType": "AllVersionsOfAllFiles" }, { "recordId": "0333844867764f819ea5a3cd006e67c5", "targetTypes": [ "MasterPreview" ], "assetType": "LatestVersionOfAllFiles" }, { "targetTypes": [ "Document" ], "fileVersionId": "541DF508C2DF45B2BC69A782013CB6B8" }, { "targetTypes": [ "AdditionalFiles" ], "additionalFileId": "ad0ff17667af406994b5a8d200e99106", "actions": [ { "action": "resizeImage", "parameters": { "width": 120, "height": 110, "format": "KeepOriginal", "resolution": 300, "colorSpace": "GrayScale", "useAlphaTransparency": "true" } } ] }, { "recordId": "15e1090e37a34428a5efa3cd007c7807", "targetTypes": [ "Document" ], "assetType": "AllVersionsOfAllFiles", "actions": [ { "action": "resizeImage", "parameters": { "width": 120, "height": 150, "format": "KeepOriginal", "resolution": 300, "colorSpace": "KeepOriginal", "useAlphaTransparency": "true" } } ] } ] } }, "original-file": { "summary": "Creating a download order to get a link to the original file", "value": { "type": "download", "disableNotification": "true", "disableProcessing": "yes", "targets": [ { "recordId": "15e1090e37a34428a5efa3cd007c7807", "targetTypes": [ "Document" ], "assetType": "LatestVersionOfMasterFile" } ] } }, "mass-download-order": { "summary": "Creating a download order without preliminary checks", "value": { "type": "download", "disableNotification": "true", "targets": [ { "recordIds": [ "bb7855d00e12435d8443b13800994999", "c8816c117ffd4cdf8ee9b13800994a1e", "d2c0f429360442b48b0bb138009947f5" ], "targetTypes": [ "Document" ], "assetType": "LatestVersionOfMasterFile", "actions": [ { "action": "resizeImage", "parameters": { "width": -1, "height": -1, "format": "png", "resolution": -1, "colorSpace": "RGB", "useAlphaTransparency": "true" } } ], "filter": { "extensions": [ "png", "tif" ] } } ] } }, "email-order": { "summary": "Creating a new email order", "value": { "type": "email", "emailSubject": "ADAM generated email", "emailBody": "see attached files", "emailRecipients": [ "administrator@adamsoftware.net", "all@adamsoftware.net" ], "creatorEmail": "frank.tremens@adamsoftware.net", "priority": "Medium", "earliestStartDate": "2015-08-20T22:00:00Z", "disableNotification": "true", "targets": [ { "recordId": "15e1090e37a34428a5efa3cd007c7807", "targetTypes": [ "MasterPreview", "MasterThumbnail" ], "assetType": "AllVersionsOfAllFiles" }, { "recordId": "0333844867764f819ea5a3cd006e67c5", "targetTypes": [ "MasterPreview" ], "assetType": "LatestVersionOfAllFiles" }, { "recordId": "15e1090e37a34428a5efa3cd007c7807", "targetTypes": [ "Document" ], "assetType": "AllVersionsOfAllFiles", "actions": [ { "action": "resizeImage", "parameters": { "width": 120, "height": 150, "format": "KeepOriginal", "resolution": 300, "colorSpace": "KeepOriginal", "useAlphaTransparency": "true" } } ] } ] } }, "ftp-resort-order": { "summary": "Creating a new FTP resort order", "value": { "type": "ftpResort", "creatorEmail": "frank.tremens@adamsoftware.net", "priority": "Medium", "earliestStartDate": "2015-08-20T22:00:00Z", "disableNotification": "true", "targets": [ { "recordId": "15e1090e37a34428a5efa3cd007c7807", "targetTypes": [ "MasterPreview", "MasterThumbnail" ], "assetType": "AllVersionsOfAllFiles" }, { "recordId": "0333844867764f819ea5a3cd006e67c5", "targetTypes": [ "MasterPreview" ], "assetType": "LatestVersionOfAllFiles" }, { "recordId": "15e1090e37a34428a5efa3cd007c7807", "targetTypes": [ "Document" ], "assetType": "AllVersionsOfAllFiles", "actions": [ { "action": "resizeImage", "parameters": { "width": 120, "height": 150, "format": "KeepOriginal", "resolution": 300, "colorSpace": "KeepOriginal", "useAlphaTransparency": "true" } } ] } ] } }, "sharedownloadlink-order": { "summary": "Creating a new shared download link order", "value": { "type": "shareDownloadLink", "creatorEmail": "frank.tremens@adamsoftware.net", "priority": "Medium", "earliestStartDate": "2015-08-20T22:00:00Z", "disableNotification": "true", "sendEmail": "true", "useVerification": "true", "expirationDateTime": "2015-09-20T22:00:00Z", "emailRecipients": [ "administrator@adamsoftware.net", "all@adamsoftware.net" ], "emailMessage": "Please find the shared files attached.", "displayName": "Q3 Campaign Assets", "originType": "Collection", "targets": [ { "recordId": "15e1090e37a34428a5efa3cd007c7807", "targetTypes": [ "MasterPreview" ], "assetType": "AllVersionsOfAllFiles" } ] } }, "public-cdn-order-original": { "summary": "Creating a new public cdn order for the latest master file of the record (Original file)", "value": { "type": "publicCdn", "targets": [ { "recordId": "24bb7956-afff-44f1-aae7-b0ff00cf440a" } ] } }, "public-cdn-order-rendition": { "summary": "Creating a new public cdn order for the latest master file of the record converted to png and give it downloadResizedPng renditionName", "value": { "type": "publicCdn", "targets": [ { "recordId": "24bb7956-afff-44f1-aae7-b0ff00cf440a", "renditionName": "downloadResizedPng", "actions": [ { "action": "resizeImage", "parameters": { "width": -1, "height": -1, "format": "png", "resolution": -1, "colorSpace": "RGB", "useAlphaTransparency": "true" } } ] } ] } }, "public-cdn-order-additionalfile": { "summary": "Creating a new public cdn order for specific additional file of the record", "value": { "type": "publicCdn", "targets": [ { "recordId": "9dbdcdd123c346a4a863aa5500ac42c9", "additionalFileId": "7495552b-1e26-4473-b121-aa6b0085f880" } ] } }, "share-download-link-order": { "summary": "Creating a share download link order and emailing it to the recipients", "value": { "type": "shareDownloadLink", "targets": [ { "recordId": "15e1090e37a34428a5efa3cd007c7807", "targetTypes": [ "Document" ], "assetType": "LatestVersionOfMasterFile" } ], "sendEmail": true, "emailRecipients": [ "administrator@adamsoftware.net", "all@adamsoftware.net" ], "emailMessage": "Here is your shared download link." } }, "follow-up": { "summary": "Following up on an order", "value": { "_links": { "self": { "href": "/order/f0233034fd8441028977a4f000e0d35d" } }, "id": "f0233034fd8441028977a4f000e0d35d", "status": "Executing", "deliveredFiles": [ ] } } } } }, "required": true }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/AkamaiCdnOrderResource" }, { "$ref": "#/components/schemas/BrandTemplateOrderResource" }, { "$ref": "#/components/schemas/BrandTemplatePreprocessingOrderResource" }, { "$ref": "#/components/schemas/DownloadOrderResource" }, { "$ref": "#/components/schemas/EmailOrderResource" }, { "$ref": "#/components/schemas/FtpOrderResource" }, { "$ref": "#/components/schemas/FtpResortOrderResource" }, { "$ref": "#/components/schemas/PublicCdnOrderResource" }, { "$ref": "#/components/schemas/ShareDownloadLinkOrderResource" }, { "$ref": "#/components/schemas/DownloadContactSheetResource" } ], "discriminator": { "propertyName": "orderType", "mapping": { "akamaiCdn": "#/components/schemas/AkamaiCdnOrderResource", "brandTemplate": "#/components/schemas/BrandTemplateOrderResource", "brandTemplatePreprocessing": "#/components/schemas/BrandTemplatePreprocessingOrderResource", "download": "#/components/schemas/DownloadOrderResource", "email": "#/components/schemas/EmailOrderResource", "ftp": "#/components/schemas/FtpOrderResource", "ftpResort": "#/components/schemas/FtpResortOrderResource", "publicCdn": "#/components/schemas/PublicCdnOrderResource", "shareDownloadLink": "#/components/schemas/ShareDownloadLinkOrderResource", "contactsheet": "#/components/schemas/DownloadContactSheetResource" } } } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/order/{orderId}/targets": { "get": { "tags": [ "Order" ], "summary": "Read all targets of an order", "operationId": "getOrderTargetsByOrderId", "parameters": [ { "name": "orderId", "in": "path", "description": "id of the order", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "$ref": "#/components/mediaTypes/OrderTargetCollectionResourceJson" }, "application/hal+json": { "$ref": "#/components/mediaTypes/OrderTargetCollectionResourceHal" } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/order/{orderId}/target/{orderTargetId}": { "get": { "tags": [ "Order" ], "summary": "Read an order target", "operationId": "getOrderTargetByOrderIdAndOrderTargetId", "parameters": [ { "name": "orderId", "in": "path", "description": "id of the order", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "orderTargetId", "in": "path", "description": "id of the order target", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderTargetResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/permission/{permissionName}": { "get": { "tags": [ "Permission" ], "summary": "Read a permission by its name", "description": "### Examples\n\nSearching for permission\n\n```http\nGET /permission/MyRolePermission\n```", "operationId": "getPermissionByPermissionName", "parameters": [ { "name": "permissionName", "in": "path", "description": "name of the permission", "required": true, "schema": { "type": "string" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PermissionResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "put": { "tags": [ "Permission" ], "summary": "Edit an existing permission", "operationId": "updatePermissionByPermissionName", "parameters": [ { "name": "permissionName", "in": "path", "description": "The name of the permission to edit.", "required": true, "schema": { "type": "string" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PermissionEditCommand" }, "example": { "name": "NewPermissionName", "labels": [ { "languageId": "C2BD4F9B-BB95-4BCB-80C3-1E924C9C26DC", "value": "My Security Permission Name In English" }, { "languageId": "5d557ae8-fd16-4dbb-a9d9-a80400dfa639", "value": "My Security Permission Name In German" } ] } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/permissions": { "get": { "tags": [ "Permission" ], "summary": "Read a collection of permissions", "description": "### Examples\n\nSearching for permissions (HTTP headers)\n\n```http\nGET /permissions\naccept: application/hal+json\npage: 1\npageSize: 20\n```\n\nSearching for permissions (query string parameters)\n\n```http\nGET /permissions?page=1&pagesize=10\n```", "operationId": "getPermissions", "parameters": [ { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "1-based page number, used together with \"pageSize\". Defaults to the first page. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Number of items per page, used together with \"page\". Too high values will be capped. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of items to skip, used together with \"take\" as an alternative to \"page\"/\"pageSize\". May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "take", "in": "query", "description": "Number of items to return, used together with \"skip\" as an alternative to \"page\"/\"pageSize\". Too high values will be capped. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "title": "Permission paged collection resource", "type": "object", "properties": { "pageNumber": { "type": [ "null", "integer" ], "description": "The current page of this paged collection.", "format": "int32" }, "pageSize": { "type": [ "null", "integer" ], "description": "The current page size of this paged collection.", "format": "int32" }, "skip": { "type": [ "null", "integer" ], "description": "The current skip size of this paged collection.", "format": "int32" }, "take": { "type": [ "null", "integer" ], "description": "The current take size of this paged collection.", "format": "int32" }, "totalCount": { "type": "integer", "description": "The total count of items in this paged collection, not just on the current page.", "format": "int64" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/PermissionResource" }, "description": "One page of this paged collection, which is a subcollection of the complete collection." } }, "description": "Representation of a paged collection of permissions" } }, "application/hal+json": { "schema": { "required": [ "_links" ], "$ref": "#/components/schemas/PermissionPagedCollectionResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/publiclink/{publicLinkId}": { "get": { "tags": [ "Public link" ], "summary": "Read a public link", "description": "### Examples\n\nReading a public link\n\nIf the public link was not found, the API call will fail with a **404 Not found** HTTP status code.\n\n```http\nGET /publiclink/59f9fb3858344bb8b6ded0da35ec9437\n```", "operationId": "getPubliclinkByPublicLinkId", "parameters": [ { "name": "publicLinkId", "in": "path", "description": "id of the public link", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicLinkResource" }, "example": { "_links": { "modifiedby": { "href": "/user/98c01138110445281215afb8cd61d3bc", "select-key": "modifiedby" }, "createdby": { "href": "/user/98c01138110445281215afb8cd61d3bc", "select-key": "createdby" }, "self": { "href": "/publiclink/59f9fb3858344bb8b6ded0da35ec9437" } }, "uri": "/zzzz/wzhpqiWZlnfNvHYoQiHM2g/oHIMo6kHB-uUmyVsNGfLVA/qq11/10.jpg", "status": "Published", "provider": "FastlyCDN", "canDelete": true, "id": "59f9fb3858344bb8b6ded0da35ec9437", "modifiedOn": "2019-05-10T13:29:57.59", "createdOn": "2019-05-10T13:29:52.593" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "put": { "tags": [ "Public link" ], "summary": "Edit an existing public link", "operationId": "updatePubliclinkByPublicLinkId", "parameters": [ { "name": "publicLinkId", "in": "path", "description": "The id of the public link.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicLinkEditCommand" }, "example": { "renditionName": "renditionName", "URI": "http://you_uri.jpg", "provider": "providerName", "fileSize": 5678 } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "delete": { "tags": [ "Public link" ], "summary": "Delete a public link", "description": "### Examples\n\nDeleting a public link\n\n```http\nDELETE /publiclink/59f9fb3858344bb8b6ded0da35ec9437\n```\n\nFiltering for origins\n\nAdd the header 'select-publiclink-origin' with the requested value. This value can be a single origin, or a comma separated string of origins (Order, API).\n\nFiltering for providers\n\nAdd the header 'select-publiclink-provider' with the requested value. This value can be a single provider, or a comma separated string of providers (case ignored).", "operationId": "deletePubliclinkByPublicLinkId", "parameters": [ { "name": "publicLinkId", "in": "path", "description": "id of the public link", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/publiclinks": { "post": { "tags": [ "Public link" ], "summary": "Create a public link", "description": "### Examples\n\nCreating a public link for latest version of master file\n\nPlease note that **POST /publiclinks** is used when you want to import public links created in your own CDN, rather than using those generated by DAM. If your intention is not to use your own CDN but instead to create public links directly in DAM, you need to create an order with type **publicCDN**. For more details, see the Working with orders section.\n\nCreating a public link for specific version\n\nPlease note that **POST /publiclinks** is used when you want to import public links created in your own CDN, rather than using those generated by DAM. If your intention is not to use your own CDN but instead to create public links directly in DAM, you need to create an order with type **publicCDN**. For more details, see the Working with orders section.\n\n```http\nPOST /publiclinks\n{\n\t\"renditionName\": \"renditionName\",\n\t\"URI\": \"http://you_uri.jpg\",\n\t\"provider\": \"providerName\",\n\t\"recordId\": \"227a694b1de8497da374af740082ddab\",\n\t\"fileVersionId\": \"54efc7a0482a476a89c69d6f6dec4fac\",\n\t\"fileSize\": 1234\n}\n```", "operationId": "createPubliclinks", "parameters": [ { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicLinkCreateCommand" }, "example": { "renditionName": "renditionName", "URI": "http://you_uri.jpg", "provider": "providerName", "recordId": "227a694b1de8497da374af740082ddab", "fileSize": 1234 } } }, "required": true }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicLinkResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/record/{recordId}": { "get": { "tags": [ "Record" ], "summary": "Read a record", "description": "### Examples\n\nReading a record without embedded resources\n\nIn case of **hal+json**, all subresources are represented as links to these resources.\n\nIn case of **json**, all subresources are returned as null values.\n\nSee the `Reading a record without embedded resources (hal+json)` and `Reading a record without embedded resources (json)` response examples in the responses panel.\n\n```http\nGET /record/271ee18ad0884ecebfc3a3cd0069d759\naccept: application/hal+json\n```\n\n```http\nGET /record/271ee18ad0884ecebfc3a3cd0069d759\naccept: application/json\n```\n\nReading a record with embedded thumbnail and preview\n\n```http\nGET /record/271ee18ad0884ecebfc3a3cd0069d759\naccept: application/hal+json\nselect-record: thumbnail\nselect-record: preview\n```", "operationId": "getRecordByRecordId", "parameters": [ { "name": "recordId", "in": "path", "description": "id of the record", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" }, "examples": { "read": { "value": "application/hal+json" }, "read-2": { "value": "application/json" }, "read-select": { "value": "application/hal+json" } } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordResource" }, "examples": { "read": { "summary": "Reading a record without embedded resources (hal+json)", "value": { "_links": { "ancestors": { "href": "/record/271ee18ad0884ecebfc3a3cd0069d759/ancestors", "select-key": "ancestors" }, "children": { "href": "/record/271ee18ad0884ecebfc3a3cd0069d759/children", "select-key": "children" }, "self": { "href": "/record/271ee18ad0884ecebfc3a3cd0069d759" }, "fields": { "href": "/record/271ee18ad0884ecebfc3a3cd0069d759/fields", "select-key": "fields" }, "files": { "href": "/record/271ee18ad0884ecebfc3a3cd0069d759/files", "select-key": "files" }, "preview": { "href": "/record/271ee18ad0884ecebfc3a3cd0069d759/image/preview", "select-key": "preview" }, "thumbnail": { "href": "/record/271ee18ad0884ecebfc3a3cd0069d759/image/thumbnail", "select-key": "thumbnail" }, "masterfile": { "href": "/record/271ee18ad0884ecebfc3a3cd0069d759/masterfile", "select-key": "masterfile" }, "classifications": { "href": "/record/271ee18ad0884ecebfc3a3cd0069d759/classifications", "select-key": "classifications" } }, "id": "271ee18ad0884ecebfc3a3cd0069d759", "createdOn": "2014-10-23T06:25:21.073Z", "modifiedOn": "2014-10-23T06:25:21.363Z", "tag": null, "title": null, "contentType": "Record" } }, "read-2": { "summary": "Reading a record without embedded resources (json)", "value": { "id": "271ee18ad0884ecebfc3a3cd0069d759", "fields": null, "files": null, "preview": null, "thumbnail": null, "masterFile": null, "createdOn": "2014-10-23T06:25:21.073Z", "modifiedOn": "2014-10-23T06:25:21.363Z", "tag": null, "title": null, "contentType": "Record", "classifications": null } }, "read-select": { "summary": "Reading a record with embedded thumbnail and preview", "value": { "_links": { "self": { "href": "/record/271ee18ad0884ecebfc3a3cd0069d759" }, "fields": { "href": "/record/271ee18ad0884ecebfc3a3cd0069d759/fields", "select-key": "fields" }, "files": { "href": "/record/271ee18ad0884ecebfc3a3cd0069d759/files", "select-key": "files" }, "masterfile": { "href": "/record/271ee18ad0884ecebfc3a3cd0069d759/masterfile", "select-key": "masterfile" }, "classifications": { "href": "/record/271ee18ad0884ecebfc3a3cd0069d759/classifications", "select-key": "classifications" } }, "id": "271ee18ad0884ecebfc3a3cd0069d759", "createdOn": "2014-10-23T06:25:21.073Z", "modifiedOn": "2014-10-23T06:25:21.363Z", "tag": null, "title": null, "contentType": "Record", "_embedded": { "preview": { "_links": { "self": { "href": "/record/271ee18ad0884ecebfc3a3cd0069d759/image/preview" } }, "size": 10896, "width": 480, "height": 480, "extension": "jpg", "uri": "/image/9T72XFv_d9imNxyxhCqoRRsvStHec03rZCywLbemcY4ocOPwYGTJsG226NrGLXrYNMy6wdihphr7aqOf.../" }, "thumbnail": { "_links": { "self": { "href": "/record/271ee18ad0884ecebfc3a3cd0069d759/image/thumbnail" } }, "size": 3225, "width": 160, "height": 160, "extension": "jpg", "uri": "/image/9T72XFv_d9imNxyxhCqoRRsvStHec03rZCywLbemcY4ocOPwYGTJsG226NrGLXrYNMy6wdihphr7aqOf.../" } } } } } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "put": { "tags": [ "Record" ], "summary": "Edit an existing record", "description": "### Examples\n\nImmediate propagation for record updates\n\nFor POST, PUT and DELETE operations on the /record resource you can force an immediate update of the search index, or immediate propagation. To do so, add the boolean header/query-string parameter **set-immediateSearchIndexUpdate** and set it to \"true\". If you don't specify this parameter, or set it to \"false\", the change will be added to the queue of the Enterprise search synchronization process. Setting the parameter to true will immediately push the record changes to the search index, so that this record can immediately be found, e.g. while an ETL import is still running. This is important, for example, when importing both the child and parent of linked records.\n\nEditing a record (full body)\n\n\"id\" for addOrUpdate of a file version, additional file or file preview can be a token or a guid. When adding a new file version, additional file or file preview, you pass the token which you get after uploading a file (please check the \"See also\" section below). When editing, you pass the guid of an existing file.\n\nTo create a new file, you have to specify at least one file version with a token for its file content.\n\nThe client id must match the accessCode in the .validationAndRuleDisablingRules system setting, and that setting entry's \"disableValidation\" and/or \"disableRules\" must also be set to true.\n\n```http\ndisable-validations: true\ndisable-rules: true\nclient-id: {clientId}\n```", "operationId": "updateRecordByRecordId", "parameters": [ { "name": "recordId", "in": "path", "description": "id of the record", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } }, { "name": "set-immediateSearchIndexUpdate", "in": "header", "description": "When true, updates the search index immediately instead of waiting for the next scheduled update. This makes the change searchable sooner but slows down the request, since it now waits on indexing instead of returning as soon as the record is saved.", "schema": { "type": "string" } }, { "name": "disable-validations", "in": "header", "description": "When set, skips field and business rule validations.", "schema": { "type": "string" } }, { "name": "disable-rules", "in": "header", "description": "When set, skips rule execution for this operation.", "schema": { "type": "string" } }, { "name": "client-id", "in": "header", "description": "Client-supplied identifier used to correlate this request.", "schema": { "type": "string" } }, { "name": "copyFromLatestVersion", "in": "header", "description": "When set, only the latest file version is processed instead of all versions.", "schema": { "type": "string" } }, { "name": "recreateAutomaticPreviews", "in": "header", "description": "When set, recreates automatic previews for the record's files.", "schema": { "type": "string" } }, { "name": "copyFilesInBackgroundProcess", "in": "header", "description": "When set, copies files in a background process instead of synchronously.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordEditCommand" }, "examples": { "records-metadata-file": { "summary": "Apply metadata", "value": { "metadata": { "name": "ImportSchema", "token": "NzZBN0Y0NDctRjQyMy00NTJDLThDNEMtMUY4MkQ0MjA4OUU0" } } }, "edit": { "summary": "Editing a record (full body)", "value": { "tag": "some tag", "contentType": "Record", "classifications": { "addOrUpdate": [ { "id": "F0962A92-8725-4FFC-9301-926FFCB6527A", "sortIndex": 2 }, { "id": "AB57432B-C899-40CF-BD44-802D5201973C", "sortIndex": 1 } ], "remove": [ { "id": "1A5842C2-3204-41F9-9527-D7E2F293131E" }, { "id": "D78B9DA1-A1E2-4DBE-8E2A-8F8FA62667F5" }, { "id": "09F59FE8-CD01-43FB-8B17-146C0AAB7A6A" } ] }, "files": { "master": "NzZBN0Y0NDctRjQyMy00NTJDLThDNEMtMUY4MkQ0MjA4OUU0", "addOrUpdate": [ { "versions": { "addOrUpdate": [ { "id": "NzZBN0Y0NDctRjQyMy00NTJDLThDNEMtMUY4MkQ0MjA4OUU0", "fileName": "file1.png", "tag": "some other tag", "versionLabel": "this is a dummy label", "comment": "this is a comment for file with fields update" } ] }, "fields": { "addOrUpdate": [ { "id": "cddb3052c3694f3496efec4e1fdda338", "localizedValues": [ { "languageId": "c2bd4f9bbb954bcb80c31e924c9c26dc", "value": "some text in English" }, { "languageId": "b0d62a54c4384e86945ea4b1009ed109", "value": "some text in Dutch" } ] } ], "remove": [ { "id": "b75af862c30a496698ac6bdd7a86618f" } ] } }, { "id": "72728492-E0C1-4695-B2AA-6FE17E96FDF5", "versions": { "addOrUpdate": [ { "id": "EAE049FC-F7CB-49D0-87B2-D0A0E8B79774", "fileName": "file3.png", "tag": "yet another tag", "versionLabel": "yet another dummy label", "comment": "yet another comment", "additionalFiles": { "addOrUpdate": [ { "id": "MkYzQjc0MTctQ0E3Ri00QUFELUEwQkQtNEIzRkQ2NzczOEY0", "label": "new additional file label", "tag": "and here yet another tag", "fileName": "new filename.jpg", "purposes": [ "review", "lowres" ] } ], "remove": [ { "id": "148BA512-5618-2246-8D94-72589D721B0Y" } ] }, "Previews": { "master": "MzRBMTA1MTYtQ0UyOC00RDRGLTlGOUEtNzQxMjg2NjgzMDNG", "addOrUpdate": [ { "id": "MzRBMTA1MTYtQ0UyOC00RDRGLTlGOUEtNzQxMjg2NjgzMDNG", "name": "new file preview", "pageNumber": 2, "tag": "oh yes, one more tag" } ], "remove": [ { "id": "AAEC425A-CA87-4495-B10D-CBA97776E9AA" } ] }, "publicationItems": [ { "pageNumber": 1, "targetFileVersionId": "C8A0DBE0-4513-4A85-B31C-E2F3D68E5CE1" }, { "pageNumber": 2, "targetFileVersionId": "D166A072-2D0D-42CE-810B-3E76F64BFFBD" } ] } ], "remove": [ { "id": "318BA544-7453-4527-8D97-23589D721D9C" }, { "id": "B1137AEC-16DF-4E6C-96CF-007D74263530" } ] } }, { "id": "DA75E95E-E306-4F1D-BAEB-A5980109C930", "watermarktype": "UseSpecified", "watermarkId": "CF4F6966-398D-4B26-B08B-2F5FE4809FD4" }, { "id": "DA75E95E-E306-4F1D-BAEB-A5980109C930", "versions": { "addOrUpdate": [ { "id": "D55D1DE0-7E8E-4AF7-BF78-A598010AC47D", "watermarktype": "None", "watermarkId": "00000000-0000-0000-0000-000000000000" } ] } } ], "remove": [ { "id": "5B044ECA-7E34-4242-B608-9B942BF3063A" } ] }, "fields": { "addOrUpdate": [ { "id": "b149288b81d741d8b721a3cd0069b113", "localizedValues": [ { "languageId": "c2bd4f9bbb954bcb80c31e924c9c26dc", "value": "some text in English" }, { "languageId": "b0d62a54c4384e86945ea4b1009ed109", "value": "some text in Dutch" } ] }, { "id": "6980bb9511454c4896afa48f009ac883", "localizedValues": [ { "languageId": "00000000000000000000000000000000", "values": [ "3240c776b7454ac19291a3cd006ea6c3", "209d7ede48004a008885a3cd006b8b8c" ] } ] }, { "id": "4d29b74f7ad2435294b9a49700a4ac3f", "localizedValues": [ { "languageId": "00000000000000000000000000000000", "parents": [ { "recordId": "8c19b5cb663b4f3ea4d7a3cd0069b4a8" } ], "children": [ { "recordId": "7c0040fd01b64c3485bda3cd0069b377" }, { "recordId": "98e9cd4e992f496ba3aea3cd0069b3b3" } ] } ] }, { "id": "e25dcaf794a8445d82b799fc6908557d", "localizedValues": [ { "languageId": "00000000000000000000000000000000", "hyperlinks": [ { "url": "https://www.aprimo.com", "displayText": "Aprimo website" } ] } ] } ], "remove": [ { "id": "b149288b81d741d8b721a3cd0069b113" } ] } } }, "edit-attributesonly": { "summary": "Editing a record (attributes only)", "value": { "tag": "some tag", "contentType": "Record" } } } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "delete": { "tags": [ "Record" ], "summary": "Delete the specified record", "description": "### Examples\n\nDeleting a record\n\nIf the header ForceDelete is set to True, then a locked asset will get forced delete (request user must be granted with specific permission 'Override Delete Usage Lock').\n\n```http\nDELETE /record/8735a5a3e75a4bc0a2a1a3cd0069b669\n```", "operationId": "deleteRecordByRecordId", "parameters": [ { "name": "recordId", "in": "path", "description": "id of the record", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } }, { "name": "set-immediateSearchIndexUpdate", "in": "header", "description": "May also be sent as a query-string parameter of the same name. When true, updates the search index immediately instead of waiting for the next scheduled update.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Success" }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/record": { "get": { "tags": [ "Record" ], "summary": "Either read a record using a unique field and its value, or read a record using a file id", "description": "### Examples\n\nReading a record using a file id\n\nThis endpoint allows you to retrieve a record based on an associated file id\n\n```http\nGET /record/?fileid={id}\naccept: application/hal+json\n```\n\nReading a record using a unique identifier field\n\nIf the value specified is from a numeric field, it will be parsed to a decimal with the culture of the logged on user.\n\n```http\nGET /record/?fieldName={name}&fieldValue={value}\naccept: application/hal+json\n```", "operationId": "getRecord", "parameters": [ { "name": "fileId", "in": "query", "description": "Value of the file id", "schema": { "type": [ "null", "string" ], "format": "uuid" } }, { "name": "fieldName", "in": "query", "description": "Name of the unique field", "required": true, "schema": { "type": "string" } }, { "name": "fieldValue", "in": "query", "description": "Value of the field. If a numeric field value is specified, make sure to enter this value as a Culture Invariant string.", "required": true, "schema": { "type": "string" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordResource" }, "examples": { "Read-using-file-id": { "summary": "Reading a record using a file id", "value": { "id": "271ee18ad0884ecebfc3a3cd0069d759", "fields": null, "files": null, "preview": null, "thumbnail": null, "masterFile": null, "createdOn": "2014-10-23T06:25:21.073Z", "modifiedOn": "2014-10-23T06:25:21.363Z", "tag": null, "title": null, "contentType": "Record", "classifications": null } }, "Read-using-unique-identifier-field": { "summary": "Reading a record using a unique identifier field", "value": { "id": "271ee18ad0884ecebfc3a3cd0069d759", "fields": null, "files": null, "preview": null, "thumbnail": null, "masterFile": null, "createdOn": "2014-10-23T06:25:21.073Z", "modifiedOn": "2014-10-23T06:25:21.363Z", "tag": null, "title": null, "contentType": "Record", "classifications": null } } } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/records": { "get": { "tags": [ "Record" ], "summary": "Read a collection of records", "description": "### Examples\n\nSearching for records (HTTP headers)\n\n```http\nGET /records\naccept: application/hal+json\nfilter: FileCount = 2\nsort: createdon\npage: 1\npageSize: 20\n```\n\nSearching for records (query string parameters)\n\n```http\nGET /records?filter=FileCount = 2&sort=createdon&page=1&pagesize=10\n```\n\nSearching for records (headers + query string combined)\n\n```http\nGET /records?page=1&pagesize=10\nfilter: FileCount = 2\nsort: createdon\n```", "operationId": "getRecords", "parameters": [ { "name": "cursor", "in": "query", "description": "Optional opaque cursor returned by a previous page's nextCursor field. When supplied, paging resumes from that position instead of an offset.", "schema": { "type": "string" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "A filter expression restricting which items are returned, e.g. \"ModifiedOn in today\". Omit to return all items the caller may see. The query parameter is the canonical location for this filter; the same value may alternatively be sent as a same-named request header.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "The property to sort by, optionally suffixed to control direction, e.g. \"createdOn\". Omit for the endpoint's default order. May also be sent as a same-named request header.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "1-based page number, used together with \"pageSize\". Defaults to the first page. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Number of items per page, used together with \"page\". Too high values will be capped. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of items to skip, used together with \"take\" as an alternative to \"page\"/\"pageSize\". May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "take", "in": "query", "description": "Number of items to return, used together with \"skip\" as an alternative to \"page\"/\"pageSize\". Too high values will be capped. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "title": "Record paged collection resource", "type": "object", "properties": { "nextCursor": { "type": [ "null", "string" ], "description": "Opaque cursor for the next page. Pass back as cursor in the next request to continue from exactly this position at constant cost per page, regardless of depth. Null when this is the last page or the result set is empty." }, "pageNumber": { "type": [ "null", "integer" ], "description": "The current page of this paged collection.", "format": "int32" }, "pageSize": { "type": [ "null", "integer" ], "description": "The current page size of this paged collection.", "format": "int32" }, "skip": { "type": [ "null", "integer" ], "description": "The current skip size of this paged collection.", "format": "int32" }, "take": { "type": [ "null", "integer" ], "description": "The current take size of this paged collection.", "format": "int32" }, "totalCount": { "type": "integer", "description": "The total count of items in this paged collection, not just on the current page.", "format": "int64" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/RecordResource" }, "description": "One page of this paged collection, which is a subcollection of the complete collection." } }, "description": "Representation of a paged collection of records" } }, "application/hal+json": { "schema": { "required": [ "_links" ], "$ref": "#/components/schemas/RecordPagedCollectionResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "post": { "tags": [ "Record" ], "summary": "Create a new record", "description": "### Examples\n\nCreating a record with validation and rules disabled\n\nThe client id must match the accessCode in the .validationAndRuleDisablingRules system setting, and that setting entry's \"disableValidation\" and/or \"disableRules\" must also be set to true.\n\n```http\ndisable-validations: true\ndisable-rules: true\nclient-id: {clientId}\n```", "operationId": "createRecords", "parameters": [ { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } }, { "name": "copyFrom", "in": "header", "description": "Identifier of the record template to copy field values and settings from.", "schema": { "type": "string" } }, { "name": "set-immediateSearchIndexUpdate", "in": "header", "description": "When true, updates the search index immediately instead of waiting for the next scheduled update. This makes the change searchable sooner but slows down the request, since it now waits on indexing instead of returning as soon as the record is saved.", "schema": { "type": "string" } }, { "name": "disable-validations", "in": "header", "description": "When set, skips field and business rule validations.", "schema": { "type": "string" } }, { "name": "disable-rules", "in": "header", "description": "When set, skips rule execution for this operation.", "schema": { "type": "string" } }, { "name": "client-id", "in": "header", "description": "Client-supplied identifier used to correlate this request.", "schema": { "type": "string" } }, { "name": "copyFromLatestVersion", "in": "header", "description": "When set, only the latest file version is processed instead of all versions.", "schema": { "type": "string" } }, { "name": "recreateAutomaticPreviews", "in": "header", "description": "When set, recreates automatic previews for the record's files.", "schema": { "type": "string" } }, { "name": "copyFilesInBackgroundProcess", "in": "header", "description": "When set, copies files in a background process instead of synchronously.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordCreateCommand" }, "examples": { "create": { "summary": "Creating a new record", "value": { "tag": "test tag", "contentType": "Record", "classifications": { "addOrUpdate": [ { "id": "F0962A92-8725-4FFC-9301-926FFCB6527A", "sortIndex": 2 }, { "id": "AB57432B-C899-40CF-BD44-802D5201973C", "sortIndex": 1 } ] }, "files": { "master": "NzZBN0Y0NDctRjQyMy00NTJDLThDNEMtMUY4MkQ0MjA4OUU0", "addOrUpdate": [ { "versions": { "addOrUpdate": [ { "id": "NzZBN0Y0NDctRjQyMy00NTJDLThDNEMtMUY4MkQ0MjA4OUU0", "fileName": "file1.png", "tag": "another test tag", "versionLabel": "this is a dummy label", "comment": "this is a comment" } ] } }, { "versions": { "addOrUpdate": [ { "id": "NDBFNEY4REMtN0FDQS00NjE2LUJFOTgtQTkxNTk5MTJENTFG", "fileName": "file3.png", "tag": "yet another test tag", "versionLabel": "yet another dummy label", "comment": "yet another comment", "additionalFiles": { "addOrUpdate": [ { "id": "MkYzQjc0MTctQ0E3Ri00QUFELUEwQkQtNEIzRkQ2NzczOEY0", "label": "new additional file label", "tag": "and here yet another tag", "fileName": "additional file name.jpg" } ] }, "previews": { "addOrUpdate": [ { "id": "MzRBMTA1MTYtQ0UyOC00RDRGLTlGOUEtNzQxMjg2NjgzMDNG", "label": "new file preview", "pageNumber": 2, "tag": "oh yes, one more tag" } ] }, "publicationItems": [ { "pageNumber": 1, "targetFileVersionId": "C8A0DBE0-4513-4A85-B31C-E2F3D68E5CE1" }, { "pageNumber": 2, "targetFileVersionId": "D166A072-2D0D-42CE-810B-3E76F64BFFBD" } ] } ] } }, { "id": "DA75E95E-E306-4F1D-BAEB-A5980109C930", "watermarktype": "UseSpecified", "watermarkId": "CF4F6966-398D-4B26-B08B-2F5FE4809FD4" }, { "id": "DA75E95E-E306-4F1D-BAEB-A5980109C930", "versions": { "addOrUpdate": [ { "id": "D55D1DE0-7E8E-4AF7-BF78-A598010AC47D", "watermarktype": "None", "watermarkId": "00000000-0000-0000-0000-000000000000" } ] } } ] }, "fields": { "addOrUpdate": [ { "id": "6980bb9511454c4896afa48f009ac883", "localizedValues": [ { "languageId": "00000000000000000000000000000000", "values": [ "3240c776b7454ac19291a3cd006ea6c3", "209d7ede48004a008885a3cd006b8b8c" ] } ] } ] } } }, "create-draft": { "summary": "Creating a new draft record", "value": { "status": "draft", "files": { "master": "MDJkMmY4ZGQ1YjFlNDQxMjgwOTFhODMzMDBkZGEzMjM=", "addOrUpdate": [ { "versions": { "addOrUpdate": [ { "id": "MDJkMmY4ZGQ1YjFlNDQxMjgwOTFhODMzMDBkZGEzMjM=", "fileName": "testFile.txt", "tag": "another test tag", "versionLabel": "this is a dummy label", "comment": "this is a comment" } ] } } ] } } }, "create-duplicate": { "summary": "Creating a duplicate of a record", "value": { "tag": "some tag", "contentType": "Record", "classifications": { "addOrUpdate": [ { "id": "F0962A92-8725-4FFC-9301-926FFCB6527A", "sortIndex": 2 }, { "id": "AB57432B-C899-40CF-BD44-802D5201973C", "sortIndex": 1 } ], "remove": [ { "id": "1A5842C2-3204-41F9-9527-D7E2F293131E" }, { "id": "D78B9DA1-A1E2-4DBE-8E2A-8F8FA62667F5" }, { "id": "09F59FE8-CD01-43FB-8B17-146C0AAB7A6A" } ] }, "files": { "master": "NzZBN0Y0NDctRjQyMy00NTJDLThDNEMtMUY4MkQ0MjA4OUU0", "addOrUpdate": [ { "versions": { "addOrUpdate": [ { "id": "NzZBN0Y0NDctRjQyMy00NTJDLThDNEMtMUY4MkQ0MjA4OUU0", "fileName": "file1.png", "tag": "some other tag", "versionLabel": "this is a dummy label", "comment": "this is a comment for file with fields update" } ] }, "fields": { "addOrUpdate": [ { "id": "cddb3052c3694f3496efec4e1fdda338", "localizedValues": [ { "languageId": "c2bd4f9bbb954bcb80c31e924c9c26dc", "value": "some text in English" }, { "languageId": "b0d62a54c4384e86945ea4b1009ed109", "value": "some text in Dutch" } ] } ], "remove": [ { "id": "b75af862c30a496698ac6bdd7a86618f" } ] } }, { "id": "72728492-E0C1-4695-B2AA-6FE17E96FDF5", "versions": { "addOrUpdate": [ { "id": "EAE049FC-F7CB-49D0-87B2-D0A0E8B79774", "fileName": "file3.png", "tag": "yet another tag", "versionLabel": "yet another dummy label", "comment": "yet another comment", "additionalFiles": { "addOrUpdate": [ { "id": "MkYzQjc0MTctQ0E3Ri00QUFELUEwQkQtNEIzRkQ2NzczOEY0", "label": "new additional file label", "tag": "and here yet another tag", "fileName": "new filename.jpg" } ], "remove": [ { "id": "148BA512-5618-2246-8D94-72589D721B0Y" } ] }, "Previews": { "master": "MzRBMTA1MTYtQ0UyOC00RDRGLTlGOUEtNzQxMjg2NjgzMDNG", "addOrUpdate": [ { "id": "MzRBMTA1MTYtQ0UyOC00RDRGLTlGOUEtNzQxMjg2NjgzMDNG", "name": "new file preview", "pageNumber": 2, "tag": "oh yes, one more tag" } ], "remove": [ { "id": "AAEC425A-CA87-4495-B10D-CBA97776E9AA" } ] }, "publicationItems": [ { "pageNumber": 1, "targetFileVersionId": "C8A0DBE0-4513-4A85-B31C-E2F3D68E5CE1" }, { "pageNumber": 2, "targetFileVersionId": "D166A072-2D0D-42CE-810B-3E76F64BFFBD" } ] } ], "remove": [ { "id": "318BA544-7453-4527-8D97-23589D721D9C" }, { "id": "B1137AEC-16DF-4E6C-96CF-007D74263530" } ] } }, { "id": "DA75E95E-E306-4F1D-BAEB-A5980109C930", "watermarktype": "UseSpecified", "watermarkId": "CF4F6966-398D-4B26-B08B-2F5FE4809FD4" }, { "id": "DA75E95E-E306-4F1D-BAEB-A5980109C930", "versions": { "addOrUpdate": [ { "id": "D55D1DE0-7E8E-4AF7-BF78-A598010AC47D", "watermarktype": "None", "watermarkId": "00000000-0000-0000-0000-000000000000" } ] } } ] }, "fields": { "addOrUpdate": [ { "id": "b149288b81d741d8b721a3cd0069b113", "localizedValues": [ { "languageId": "c2bd4f9bbb954bcb80c31e924c9c26dc", "value": "some text in English" }, { "languageId": "b0d62a54c4384e86945ea4b1009ed109", "value": "some text in Dutch" } ] }, { "id": "6980bb9511454c4896afa48f009ac883", "localizedValues": [ { "languageId": "00000000000000000000000000000000", "values": [ "3240c776b7454ac19291a3cd006ea6c3", "209d7ede48004a008885a3cd006b8b8c" ] } ] }, { "id": "4d29b74f7ad2435294b9a49700a4ac3f", "localizedValues": [ { "languageId": "00000000000000000000000000000000", "parents": [ { "recordId": "8c19b5cb663b4f3ea4d7a3cd0069b4a8" } ], "children": [ { "recordId": "7c0040fd01b64c3485bda3cd0069b377" }, { "recordId": "98e9cd4e992f496ba3aea3cd0069b3b3" } ] } ] } ], "remove": [ { "id": "b149288b81d741d8b721a3cd0069b113" } ] } } } } } } }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatedResourceId" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/record/bulkedits": { "post": { "tags": [ "Record" ], "summary": "Initiates edit record sessions in bulk", "description": "Initiates edit record sessions in bulk. This is the first step of the bulk edit session lifecycle: it opens an edit session for each record without persisting any changes, and returns a \"token\" field per record in the response. Pass those tokens back to PATCH /record/bulkedits to apply partial changes while keeping the sessions open, to PUT /record/bulkedits to commit and close them, or to DELETE /record/bulkedits to discard them.", "operationId": "createRecordBulkedits", "parameters": [ { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordStartBulkEditSessionCommand" } } }, "required": true }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditRecordResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "put": { "tags": [ "Record" ], "summary": "Applies the sent changes to the editable records and saves them", "description": "Applies the sent changes to the editable records and saves them. This commits the bulk edit sessions started by POST /record/bulkedits, using the tokens returned in the \"token\" field of that response, persisting the accumulated changes and closing the sessions. To apply changes without closing the sessions use PATCH /record/bulkedits instead; to discard the sessions without saving use DELETE /record/bulkedits.", "operationId": "updateRecordBulkedits", "parameters": [ { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } }, { "name": "set-immediateSearchIndexUpdate", "in": "header", "description": "May also be sent as a query-string parameter of the same name. When true, updates the search index immediately instead of waiting for the next scheduled update.", "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordCommitBulkEditSessionCommand" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditRecordResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "patch": { "tags": [ "Record" ], "summary": "Applies the sent changes to the editable records", "description": "Applies the sent changes to the editable records. This applies a partial update to the bulk edit sessions started by POST /record/bulkedits, using the tokens returned in the \"token\" field of that response (send them back in the \"tokens\" field of this request body), and does not close the sessions - they stay open for further PATCH calls until they are committed with PUT /record/bulkedits or discarded with DELETE /record/bulkedits.", "operationId": "patchRecordBulkedits", "parameters": [ { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } }, { "name": "set-immediateSearchIndexUpdate", "in": "header", "description": "May also be sent as a query-string parameter of the same name. When true, updates the search index immediately instead of waiting for the next scheduled update.", "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordPatchBulkEditSessionCommand" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditRecordResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "delete": { "tags": [ "Record" ], "summary": "Delete the edit record sessions", "description": "Delete the edit record sessions. This discards the bulk edit sessions started by POST /record/bulkedits, using the tokens returned in the \"token\" field of that response, without persisting any of the changes made during those sessions. To persist the changes instead, commit with PUT /record/bulkedits (or apply changes without closing the sessions with PATCH /record/bulkedits).", "operationId": "deleteRecordBulkedits", "parameters": [ { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } }, { "name": "set-immediateSearchIndexUpdate", "in": "header", "description": "May also be sent as a query-string parameter of the same name. When true, updates the search index immediately instead of waiting for the next scheduled update.", "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordDeleteBulkEditSessionCommand" } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/record/edits": { "post": { "tags": [ "Record" ], "summary": "Initiates an edit record session", "operationId": "createRecordEdits", "parameters": [ { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } }, { "name": "set-immediateSearchIndexUpdate", "in": "header", "description": "When true, updates the search index immediately instead of waiting for the next scheduled update. This makes the change searchable sooner but slows down the request, since it now waits on indexing instead of returning as soon as the record is saved.", "schema": { "type": "string" } }, { "name": "disable-validations", "in": "header", "description": "When set, skips field and business rule validations.", "schema": { "type": "string" } }, { "name": "disable-rules", "in": "header", "description": "When set, skips rule execution for this operation.", "schema": { "type": "string" } }, { "name": "client-id", "in": "header", "description": "Client-supplied identifier used to correlate this request.", "schema": { "type": "string" } }, { "name": "copyFromLatestVersion", "in": "header", "description": "When set, only the latest file version is processed instead of all versions.", "schema": { "type": "string" } }, { "name": "recreateAutomaticPreviews", "in": "header", "description": "When set, recreates automatic previews for the record's files.", "schema": { "type": "string" } }, { "name": "copyFilesInBackgroundProcess", "in": "header", "description": "When set, copies files in a background process instead of synchronously.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordStartEditSessionCommand" } } }, "required": true }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditRecordResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/records/edits": { "post": { "tags": [ "Record" ], "summary": "Create a new record as a draft", "description": "### Examples\n\nDuplicating a record as draft\n\nIf header makeFileNamesUnique is set to True, then all file version file names will be updated - Copy {index} will be added to make file names unique across system, i.e. original Copy, original Copy 1, original Copy 2 and so on. If header makeFileNamesUnique is set to False (default value), then all file version file names will be same as in original record. If header usePreviewsFromSource is set to True, then for created in-memory duplicate record, we will update URI's for all Previews\\Thumbnails\\Additional Files to its matching pairs from original record. You can also specify the copyRelationshipField header which allows to relate original record and the copy via record link field with OneParentManyChildren Link Type. In the copy the original record will be set as parent in that field.\n\n```http\nPOST /records/edits\n\ncopyFrom: 41f8115dd9714b27b5d8b7f1c1285d07\nmakeFileNamesUnique: true\nusePreviewsFromSource: true\ncopyRelationshipField: Name of Record Link Field\n```", "operationId": "createRecordsEdits", "parameters": [ { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } }, { "name": "copyFrom", "in": "header", "description": "Identifier of the record template to copy field values and settings from.", "schema": { "type": "string" } }, { "name": "makeFileNamesUnique", "in": "header", "description": "When set, ensures file names are made unique instead of colliding with existing files.", "schema": { "type": "string" } }, { "name": "copyRelationshipField", "in": "header", "description": "Name of the relationship field the new record should be linked through.", "schema": { "type": "string" } }, { "name": "set-immediateSearchIndexUpdate", "in": "header", "description": "When true, updates the search index immediately instead of waiting for the next scheduled update. This makes the change searchable sooner but slows down the request, since it now waits on indexing instead of returning as soon as the record is saved.", "schema": { "type": "string" } }, { "name": "disable-validations", "in": "header", "description": "When set, skips field and business rule validations.", "schema": { "type": "string" } }, { "name": "disable-rules", "in": "header", "description": "When set, skips rule execution for this operation.", "schema": { "type": "string" } }, { "name": "client-id", "in": "header", "description": "Client-supplied identifier used to correlate this request.", "schema": { "type": "string" } }, { "name": "copyFromLatestVersion", "in": "header", "description": "When set, only the latest file version is processed instead of all versions.", "schema": { "type": "string" } }, { "name": "recreateAutomaticPreviews", "in": "header", "description": "When set, recreates automatic previews for the record's files.", "schema": { "type": "string" } }, { "name": "copyFilesInBackgroundProcess", "in": "header", "description": "When set, copies files in a background process instead of synchronously.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordCreateEditSessionCommand" } } }, "required": true }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditRecordResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/record/edits/{editToken}": { "get": { "tags": [ "Record" ], "summary": "Read the current state of the edit session", "operationId": "getRecordEditsByEditToken", "parameters": [ { "name": "editToken", "in": "path", "description": "The token identifying the edit session.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } }, { "name": "set-immediateSearchIndexUpdate", "in": "header", "description": "May also be sent as a query-string parameter of the same name. When true, updates the search index immediately instead of waiting for the next scheduled update.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditRecordResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "post": { "tags": [ "Record" ], "summary": "Applies the sent changes to the editable record and saves them", "operationId": "createRecordEditsByEditToken", "parameters": [ { "name": "editToken", "in": "path", "description": "The token identifying the edit session.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } }, { "name": "set-keepEditOpen", "in": "header", "description": "When set, keeps the edit session open after committing instead of closing it.", "schema": { "type": "string" } }, { "name": "set-immediateSearchIndexUpdate", "in": "header", "description": "When true, updates the search index immediately instead of waiting for the next scheduled update. This makes the change searchable sooner but slows down the request, since it now waits on indexing instead of returning as soon as the record is saved.", "schema": { "type": "string" } }, { "name": "disable-validations", "in": "header", "description": "When set, skips field and business rule validations.", "schema": { "type": "string" } }, { "name": "disable-rules", "in": "header", "description": "When set, skips rule execution for this operation.", "schema": { "type": "string" } }, { "name": "client-id", "in": "header", "description": "Client-supplied identifier used to correlate this request.", "schema": { "type": "string" } }, { "name": "copyFromLatestVersion", "in": "header", "description": "When set, only the latest file version is processed instead of all versions.", "schema": { "type": "string" } }, { "name": "recreateAutomaticPreviews", "in": "header", "description": "When set, recreates automatic previews for the record's files.", "schema": { "type": "string" } }, { "name": "copyFilesInBackgroundProcess", "in": "header", "description": "When set, copies files in a background process instead of synchronously.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordCommitEditSessionCommand" } } } }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditRecordResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "patch": { "tags": [ "Record" ], "summary": "Applies the sent changes to the editable record", "operationId": "patchRecordEditsByEditToken", "parameters": [ { "name": "editToken", "in": "path", "description": "The token identifying the edit session.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } }, { "name": "set-immediateSearchIndexUpdate", "in": "header", "description": "When true, updates the search index immediately instead of waiting for the next scheduled update. This makes the change searchable sooner but slows down the request, since it now waits on indexing instead of returning as soon as the record is saved.", "schema": { "type": "string" } }, { "name": "disable-validations", "in": "header", "description": "When set, skips field and business rule validations.", "schema": { "type": "string" } }, { "name": "disable-rules", "in": "header", "description": "When set, skips rule execution for this operation.", "schema": { "type": "string" } }, { "name": "client-id", "in": "header", "description": "Client-supplied identifier used to correlate this request.", "schema": { "type": "string" } }, { "name": "copyFromLatestVersion", "in": "header", "description": "When set, only the latest file version is processed instead of all versions.", "schema": { "type": "string" } }, { "name": "recreateAutomaticPreviews", "in": "header", "description": "When set, recreates automatic previews for the record's files.", "schema": { "type": "string" } }, { "name": "copyFilesInBackgroundProcess", "in": "header", "description": "When set, copies files in a background process instead of synchronously.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordPatchEditSessionCommand" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditRecordResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "delete": { "tags": [ "Record" ], "summary": "Delete the edit record session", "operationId": "deleteRecordEditsByEditToken", "parameters": [ { "name": "editToken", "in": "path", "description": "The token identifying the edit session.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } }, { "name": "set-immediateSearchIndexUpdate", "in": "header", "description": "May also be sent as a query-string parameter of the same name. When true, updates the search index immediately instead of waiting for the next scheduled update.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Success" }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/record/operations/checkout": { "get": { "tags": [ "Record" ], "summary": "Return the status of the download order created after checkout", "operationId": "getRecordOperationsCheckout", "parameters": [ { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CheckOutStatusResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "post": { "tags": [ "Record" ], "summary": "Start a check-out operation", "operationId": "createRecordOperationsCheckout", "parameters": [ { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Success" }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "delete": { "tags": [ "Record" ], "summary": "Undo a check-out operation", "operationId": "deleteRecordOperationsCheckout", "parameters": [ { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/record/{objectId}/trail": { "get": { "tags": [ "Record" ], "summary": "Read the audit trail of an object, with optional type filter", "description": "### Examples\n\nReading the audit trail of a record (This route only supports paging type: Skip, Take)\n\nThe 'filter' parameter is optional and has three valid values. If a different value is passed in the request, the DAM REST API will process the request as if no filter was passed. Valid values:\n- \"\" (empty, no filter is applied)\n- \"change\" (only record changes are returned)\n- \"download\" (only downloads of files of the record are returned)\n\nSee the `Reading the audit trail of a record (This route only supports paging type: Skip, Take) (json)`, `Reading the audit trail of a record (This route only supports paging type: Skip, Take) (json 2)` and `Reading the audit trail of a record (This route only supports paging type: Skip, Take) (json 3)` response examples in the responses panel.\n\n```http\nGET /record/55C030F3-185A-4437-B01C-ABDB001F1FA9/trail\naccept: application/hal+json\n```\n\n```http\nGET /record/55C030F3-185A-4437-B01C-ABDB001F1FA9/trail?filter=\naccept: application/hal+json\n```\n\n```http\nSame response as without the 'filter' parameter.\n```\n\n```http\nGET /record/55C030F3-185A-4437-B01C-ABDB001F1FA9/trail?filter=change\naccept: application/hal+json\n```\n\n```http\nGET /record/55C030F3-185A-4437-B01C-ABDB001F1FA9/trail?filter=download\naccept: application/hal+json\n```", "operationId": "getRecordTrailByObjectId", "parameters": [ { "name": "objectId", "in": "path", "description": "The id of the object.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "filter", "in": "query", "description": "The audit event type filter.", "schema": { "enum": [ "Change", "Download" ], "type": [ "null", "string" ] } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "1-based page number, used together with \"pageSize\". Defaults to the first page. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Number of items per page, used together with \"page\". Too high values will be capped. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of items to skip, used together with \"take\" as an alternative to \"page\"/\"pageSize\". May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "take", "in": "query", "description": "Number of items to return, used together with \"skip\" as an alternative to \"page\"/\"pageSize\". Too high values will be capped. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuditEntryResource" }, "examples": { "read": { "summary": "Reading the audit trail of a record (This route only supports paging type: Skip, Take) (json)", "value": { "objectId": "55c030f3185a4437b01cabdb001f1fa9", "entryCount": 4, "entries": [ { "id": 4, "type": "recordDownloaded", "userId": "fa286193ddbf44299d2ea2390e2a8b99", "createdOn": "0001-01-01T00:00:00", "changeCount": 1 }, { "id": 3, "type": "recordModified", "userId": "fa286193ddbf44299d2ea2390e2a8b99", "createdOn": "0001-01-01T00:00:00", "changeCount": 2 }, { "id": 2, "type": "recordCreated", "userId": "fa286193ddbf44299d2ea2390e2a8b99", "createdOn": "0001-01-01T00:00:00", "changeCount": 2 }, { "id": 1, "type": "recordModified", "userId": "fa286193ddbf44299d2ea2390e2a8b99", "createdOn": "0001-01-01T00:00:00", "changeCount": 2 } ] } }, "read-2": { "summary": "Reading the audit trail of a record (This route only supports paging type: Skip, Take) (json 2)", "value": { "objectId": "55c030f3185a4437b01cabdb001f1fa9", "entryCount": 3, "entries": [ { "id": 3, "type": "recordModified", "userId": "fa286193ddbf44299d2ea2390e2a8b99", "createdOn": "0001-01-01T00:00:00", "changeCount": 2 }, { "id": 2, "type": "recordCreated", "userId": "fa286193ddbf44299d2ea2390e2a8b99", "createdOn": "0001-01-01T00:00:00", "changeCount": 2 }, { "id": 1, "type": "recordModified", "userId": "fa286193ddbf44299d2ea2390e2a8b99", "createdOn": "0001-01-01T00:00:00", "changeCount": 2 } ] } }, "read-3": { "summary": "Reading the audit trail of a record (This route only supports paging type: Skip, Take) (json 3)", "value": { "objectId": "55c030f3185a4437b01cabdb001f1fa9", "entryCount": 4, "entries": [ { "id": 4, "type": "recordDownloaded", "userId": "fa286193ddbf44299d2ea2390e2a8b99", "createdOn": "0001-01-01T00:00:00", "changeCount": 1 } ] } } } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/record/{recordId}/associatedcollections": { "get": { "tags": [ "Record" ], "summary": "Read all the associated collections for a record", "operationId": "getRecordAssociatedcollectionsByRecordId", "parameters": [ { "name": "recordId", "in": "path", "description": "Id of the record", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "1-based page number, used together with \"pageSize\". Defaults to the first page. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Number of items per page, used together with \"page\". Too high values will be capped. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of items to skip, used together with \"take\" as an alternative to \"page\"/\"pageSize\". May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "take", "in": "query", "description": "Number of items to return, used together with \"skip\" as an alternative to \"page\"/\"pageSize\". Too high values will be capped. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "$ref": "#/components/mediaTypes/IPagedCollectionResourceOfCollectionResourceJson" }, "application/hal+json": { "$ref": "#/components/mediaTypes/IPagedCollectionResourceOfCollectionResourceHal" } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/record/{recordId}/classifications": { "get": { "tags": [ "Record" ], "summary": "Read all record classifications of a record", "operationId": "getRecordClassificationsByRecordId", "parameters": [ { "name": "recordId", "in": "path", "description": "id of the record", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "The property to sort by, optionally suffixed to control direction, e.g. \"createdOn\". Omit for the endpoint's default order. May also be sent as a same-named request header.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "1-based page number, used together with \"pageSize\". Defaults to the first page. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Number of items per page, used together with \"page\". Too high values will be capped. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of items to skip, used together with \"take\" as an alternative to \"page\"/\"pageSize\". May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "take", "in": "query", "description": "Number of items to return, used together with \"skip\" as an alternative to \"page\"/\"pageSize\". Too high values will be capped. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "$ref": "#/components/mediaTypes/RecordClassificationCollectionResourceJson" }, "application/hal+json": { "$ref": "#/components/mediaTypes/RecordClassificationCollectionResourceHal" } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/record/{recordId}/downloadagreement": { "get": { "tags": [ "Record" ], "summary": "Read the download agreement's content for a record", "description": "### Examples\n\nReading a record's download agreement\n\nReturned in the language of the logged-in user.\n\n```http\nGET /record/8735a5a3e75a4bc0a2a1a3cd0069b669/downloadagreement\n```", "operationId": "getRecordDownloadagreementByRecordId", "parameters": [ { "name": "recordId", "in": "path", "description": "id of the record", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DownloadAgreementContentResource" }, "example": { "id": 135, "languageId": "c2bd4f9bbb954bcb80c31e924c9c26dc", "version": 1, "title": "Title of the download agreement", "description": "Terms of use of the download agreement" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/record/{recordId}/duplicateinfo": { "get": { "tags": [ "Record" ], "summary": "Read the full duplicate info for the latest file version of the record", "operationId": "getRecordDuplicateinfoByRecordId", "parameters": [ { "name": "recordId", "in": "path", "description": "id of the record", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "newFileName", "in": "query", "description": "Optional file name to check the duplicate info against instead of the current file name.", "schema": { "type": "string" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileVersionDuplicateInfoNonResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/record/{recordId}/fields": { "get": { "tags": [ "Record" ], "summary": "Read all fields of a record", "operationId": "getRecordFieldsByRecordId", "parameters": [ { "name": "recordId", "in": "path", "description": "id of the record", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "1-based page number, used together with \"pageSize\". Defaults to the first page. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Number of items per page, used together with \"page\". Too high values will be capped. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of items to skip, used together with \"take\" as an alternative to \"page\"/\"pageSize\". May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "take", "in": "query", "description": "Number of items to return, used together with \"skip\" as an alternative to \"page\"/\"pageSize\". Too high values will be capped. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "$ref": "#/components/mediaTypes/FieldCollectionResourceJson" }, "application/hal+json": { "$ref": "#/components/mediaTypes/FieldCollectionResourceHal" } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/record/{recordId}/files": { "get": { "tags": [ "Record" ], "summary": "Read all files of a record", "operationId": "getRecordFilesByRecordId", "parameters": [ { "name": "recordId", "in": "path", "description": "id of the record", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "$ref": "#/components/mediaTypes/FileCollectionResourceJson" }, "application/hal+json": { "$ref": "#/components/mediaTypes/FileCollectionResourceHal" } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/record/{recordId}/locks": { "get": { "tags": [ "Record" ], "summary": "Read all the locks for a record", "description": "### Examples\n\nReading locks using a unique record id\n\nAny user with READ permissions on a record can see all the locks that are on a record.\n\n```http\nGET /record/{recordId}/locks\naccept: application/json\n```", "operationId": "getRecordLocksByRecordId", "parameters": [ { "name": "recordId", "in": "path", "description": "id of the record", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordLockResource" }, "example": [ { "lockId": "be94cf247cf846fe85cdaafc010f8d3c", "integrationId": "marketingops1", "uri": "", "reason": "workflow1", "lockedOn": "2019-11-05T16:28:41.373" }, { "lockId": "d7d5c1d802604d54ac94aafc010f997c", "integrationId": "marketingops2", "uri": "", "reason": "workflow2", "lockedOn": "2019-11-05T16:28:51.827" }, { "lockId": "ab424fa0ef2c47a9a982aafc010f9f61", "integrationId": "marketingops3", "uri": "", "reason": "workflow3", "lockedOn": "2019-11-05T16:28:56.857" } ] } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "post": { "tags": [ "Record" ], "summary": "Create a lock for a record", "operationId": "createRecordLocksByRecordId", "parameters": [ { "name": "recordId", "in": "path", "description": "id of the record", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordLockCreateCommand" }, "example": { "integrationId": "integrationClient", "reason": "specific reason", "uri": "specific uri" } } }, "required": true }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatedResourceId" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/record/{recordId}/masterfile": { "get": { "tags": [ "Record" ], "summary": "Read the masterfile of a record", "operationId": "getRecordMasterfileByRecordId", "parameters": [ { "name": "recordId", "in": "path", "description": "id of the record", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/record/{recordId}/masterfilelatestversion": { "get": { "tags": [ "Record" ], "summary": "Read the latest version of the masterfile of a record", "operationId": "getRecordMasterfilelatestversionByRecordId", "parameters": [ { "name": "recordId", "in": "path", "description": "id of the record", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileVersionResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/record/{recordId}/permissions": { "get": { "tags": [ "Record" ], "summary": "Read all the permissions on a record", "operationId": "getRecordPermissionsByRecordId", "parameters": [ { "name": "recordId", "in": "path", "description": "id of the record", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordPermissionsResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/record/operations/checkin": { "post": { "tags": [ "Record" ], "summary": "Start a check-in operation", "description": "Start a check-in operation. Requires the OperationToken header, set to the token returned by the check-in prepare operation; no request body is needed.", "operationId": "createRecordOperationsCheckin", "parameters": [ { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Success" }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/record/{recordId}/classification/{classificationId}": { "get": { "tags": [ "Record" ], "summary": "Read a record classification of a record", "operationId": "getRecordClassificationByRecordIdAndClassificationId", "parameters": [ { "name": "recordId", "in": "path", "description": "id of the record", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "classificationId", "in": "path", "description": "id of the target classification (not the id of record classification)", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordClassificationResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/record/{recordId}/field/{fieldId}": { "get": { "tags": [ "Record" ], "summary": "Read a field of a record", "operationId": "getRecordFieldByRecordIdAndFieldId", "parameters": [ { "name": "recordId", "in": "path", "description": "id of the record", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "fieldId", "in": "path", "description": "id of the field", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/SingleLineTextFieldResource" }, { "$ref": "#/components/schemas/MultiLineTextFieldResource" }, { "$ref": "#/components/schemas/NumericFieldResource" }, { "$ref": "#/components/schemas/DateTimeFieldResource" }, { "$ref": "#/components/schemas/DateFieldResource" }, { "$ref": "#/components/schemas/TimeFieldResource" }, { "$ref": "#/components/schemas/OptionListFieldResource" }, { "$ref": "#/components/schemas/DurationFieldResource" }, { "$ref": "#/components/schemas/UserListFieldResource" }, { "$ref": "#/components/schemas/UserGroupListFieldResource" }, { "$ref": "#/components/schemas/HtmlFieldResource" }, { "$ref": "#/components/schemas/JsonFieldResource" }, { "$ref": "#/components/schemas/ClassificationListFieldResource" }, { "$ref": "#/components/schemas/RecordListFieldResource" }, { "$ref": "#/components/schemas/RecordLinkFieldResource" }, { "$ref": "#/components/schemas/LanguageListFieldResource" }, { "$ref": "#/components/schemas/TextListFieldResource" }, { "$ref": "#/components/schemas/HyperlinkListFieldResource" } ], "discriminator": { "propertyName": "dataType", "mapping": { "SingleLineText": "#/components/schemas/SingleLineTextFieldResource", "MultiLineText": "#/components/schemas/MultiLineTextFieldResource", "Numeric": "#/components/schemas/NumericFieldResource", "DateTime": "#/components/schemas/DateTimeFieldResource", "Date": "#/components/schemas/DateFieldResource", "Time": "#/components/schemas/TimeFieldResource", "OptionList": "#/components/schemas/OptionListFieldResource", "Duration": "#/components/schemas/DurationFieldResource", "UserList": "#/components/schemas/UserListFieldResource", "UserGroupList": "#/components/schemas/UserGroupListFieldResource", "Html": "#/components/schemas/HtmlFieldResource", "Json": "#/components/schemas/JsonFieldResource", "ClassificationList": "#/components/schemas/ClassificationListFieldResource", "RecordList": "#/components/schemas/RecordListFieldResource", "RecordLink": "#/components/schemas/RecordLinkFieldResource", "LanguageList": "#/components/schemas/LanguageListFieldResource", "TextList": "#/components/schemas/TextListFieldResource", "HyperlinkList": "#/components/schemas/HyperlinkListFieldResource" } } } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/record/{recordId}/image/preview": { "get": { "tags": [ "Record" ], "summary": "Read the preview of a record", "operationId": "getRecordImagePreviewByRecordId", "parameters": [ { "name": "recordId", "in": "path", "description": "id of the record", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImageResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/record/{recordId}/image/thumbnail": { "get": { "tags": [ "Record" ], "summary": "Read the thumbnail of a record", "operationId": "getRecordImageThumbnailByRecordId", "parameters": [ { "name": "recordId", "in": "path", "description": "id of the record", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImageResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/record/{recordId}/checkin/prepare": { "post": { "tags": [ "Record" ], "summary": "Prepare check in operation for record", "operationId": "createRecordCheckinPrepareByRecordId", "parameters": [ { "name": "recordId", "in": "path", "description": "Record id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrepareRecordCheckInCommand" } } }, "required": true }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CheckInResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/record/{recordId}/checkout/prepare": { "post": { "tags": [ "Record" ], "summary": "Prepare check out operation for record", "operationId": "createRecordCheckoutPrepareByRecordId", "parameters": [ { "name": "recordId", "in": "path", "description": "Record id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CheckOutResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/record/{recordId}/undocheckout/prepare": { "post": { "tags": [ "Record" ], "summary": "Prepare undo check out operation for record", "operationId": "createRecordUndocheckoutPrepareByRecordId", "parameters": [ { "name": "recordId", "in": "path", "description": "Record id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CheckOutResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/record/{objectId}/trail/entry/{entryId}": { "get": { "tags": [ "Record" ], "summary": "Read a specific audit trail entry of an object", "description": "### Examples\n\nReading the list of changes of an audit trail event\n\nReading the list of changes of an audit trail event after creating a copy(duplicate)\n\nSee the `Reading the list of changes of an audit trail event (json)` and `Reading the list of changes of an audit trail event (json 2)` response examples in the responses panel.\n\n```http\nGET /record/55C030F3-185A-4437-B01C-ABDB001F1FA9/trail/entry/3\naccept: application/hal+json\n```\n\n```http\nGET /record/9DBCFB32-5280-49D7-9E1F-AF8D00B68021/trail/entry/256\naccept: application/hal+json\n```", "operationId": "getRecordTrailEntryByObjectIdAndEntryId", "parameters": [ { "name": "objectId", "in": "path", "description": "The id of the object.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "entryId", "in": "path", "description": "The id of the audit entry.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuditEntryIdResource" }, "examples": { "read": { "summary": "Reading the list of changes of an audit trail event (json)", "value": { "id": 3, "objectId": "55c030f3185a4437b01cabdb001f1fa9", "userId": "fa286193ddbf44299d2ea2390e2a8b99", "createdOn": "2020-06-15T10:47:39.173Z", "changeCount": 2, "changes": [ { "type": "fileChanged", "fileId": "e0bbc57d-6670-45ed-bd0b-abdb001f6c85", "sortIndex": "1", "versionType": "versionChanged", "versionId": "0db90841-4071-4cda-ab3c-abdb001f6c85", "extension": "jpg", "fileCreatedOn": "2020-06-15T09:54:22.897+08:00", "fileModifiedOn": "2020-06-15T09:54:23.307+08:00", "fileName": "cute-cartoon-penguin-on-white-background-royalty-free-cliparts-cartoon-penguin-1143_1300.jpg", "fileSize": "72328", "fileState": "Processing", "fileTypeId": "f3aebdba-9958-494c-8e14-322941a1b66a", "path": { "@attributes": { "source": "missing" }, "#value": null }, "versionNumber": "1" }, { "type": "fileChanged", "fileId": "c7c37927-7163-410c-bc56-abdb001f8d3d", "sortIndex": "2", "versionType": "versionChanged", "versionId": "2b981af7-104c-46c7-a01b-abdb001f8d3d", "extension": "png", "fileCreatedOn": "2020-06-15T09:54:44.187+08:00", "fileModifiedOn": "2020-06-15T09:54:45.937+08:00", "fileName": "png-files-2.png", "fileSize": "322794", "fileState": "Processing", "fileTypeId": "ffa438fd-75c6-4880-a962-8f2e68e66b7a", "path": { "@attributes": { "source": "missing" }, "#value": null }, "versionNumber": "1" } ] } }, "read-2": { "summary": "Reading the list of changes of an audit trail event (json 2)", "value": { "id": 256, "objectId": "dbf4cd9f886e412b9799af9000a293ba", "userId": "98c01138110445281215afb8cd61d3bc", "createdOn": "2023-01-20T09:51:57.52", "changeCount": 4, "changes": [ { "type": "copiedFromContentItem", "copiedFromRecordId": "5621645fd5214727b9e9af9000a27844" }, { "type": "classificationAdded", "classificationId": "a1edd72b-498d-4a29-a3cf-af4801356fed", "id": "376a6fd1-2e49-4eab-97a8-af9000a293ba", "createdOn": "2023-01-20T09:51:36.99+00:00" }, { "type": "contentTypeAdded", "contentType": "Asset", "previousContentType": "" }, { "type": "statusChanged", "status": "Draft" } ] } } } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/record/{recordId}/field/{fieldId}/listvalues": { "get": { "tags": [ "Record" ], "summary": "Read the list values of a field of a record", "operationId": "getRecordFieldListvaluesByRecordIdAndFieldId", "parameters": [ { "name": "recordId", "in": "path", "description": "id of the record", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "fieldId", "in": "path", "description": "id of the field", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "A filter expression restricting which items are returned, e.g. \"ModifiedOn in today\". Omit to return all items the caller may see. The query parameter is the canonical location for this filter; the same value may alternatively be sent as a same-named request header.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "The property to sort by, optionally suffixed to control direction, e.g. \"createdOn\". Omit for the endpoint's default order. May also be sent as a same-named request header.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "1-based page number, used together with \"pageSize\". Defaults to the first page. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Number of items per page, used together with \"page\". Too high values will be capped. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of items to skip, used together with \"take\" as an alternative to \"page\"/\"pageSize\". May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "take", "in": "query", "description": "Number of items to return, used together with \"skip\" as an alternative to \"page\"/\"pageSize\". Too high values will be capped. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/OptionListFieldItemResource" } }, "page": { "type": [ "null", "integer" ] }, "pageSize": { "type": [ "null", "integer" ] }, "totalCount": { "type": "integer", "format": "int64" } }, "description": "A paged/collection response envelope." }, { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ClassificationListFieldItemResource" } }, "page": { "type": [ "null", "integer" ] }, "pageSize": { "type": [ "null", "integer" ] }, "totalCount": { "type": "integer", "format": "int64" } }, "description": "A paged/collection response envelope." }, { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/UserListFieldItemResource" } }, "page": { "type": [ "null", "integer" ] }, "pageSize": { "type": [ "null", "integer" ] }, "totalCount": { "type": "integer", "format": "int64" } }, "description": "A paged/collection response envelope." }, { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroupListFieldItemResource" } }, "page": { "type": [ "null", "integer" ] }, "pageSize": { "type": [ "null", "integer" ] }, "totalCount": { "type": "integer", "format": "int64" } }, "description": "A paged/collection response envelope." } ] } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/record/{recordId}/image/preview/download": { "get": { "tags": [ "Record" ], "summary": "Download the binary content of the related preview", "description": "### Examples\n\nRetrieve the record's preview or thumbnail image binary data\n\nThe response is the stream of the record's preview image binary data (with the content-type set to \"image/jpeg\" or \"image/png\", etc. depending on the type of the image returned). Similar request can be used to retrieve the thumbnail:\n\n```http\nGET /record/271ee18ad0884ecebfc3a3cd0069d759/image/preview/download\n```\n\n```http\nGET /record/271ee18ad0884ecebfc3a3cd0069d759/image/thumbnail/download\n```", "operationId": "getRecordImagePreviewDownloadByRecordId", "parameters": [ { "name": "recordId", "in": "path", "description": "id of the record", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/record/{recordId}/image/thumbnail/download": { "get": { "tags": [ "Record" ], "summary": "Download the binary content of the related thumbnail", "operationId": "getRecordImageThumbnailDownloadByRecordId", "parameters": [ { "name": "recordId", "in": "path", "description": "id of the record", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/record/bulkedits/field/{fieldId}/listvalues": { "post": { "tags": [ "Record" ], "summary": "Read the list values of a field across a set of bulk edit sessions", "operationId": "createRecordBulkeditsFieldListvaluesByFieldId", "parameters": [ { "name": "fieldId", "in": "path", "description": "id of the field", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "A filter expression restricting which items are returned, e.g. \"ModifiedOn in today\". Omit to return all items the caller may see. The query parameter is the canonical location for this filter; the same value may alternatively be sent as a same-named request header.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "The property to sort by, optionally suffixed to control direction, e.g. \"createdOn\". Omit for the endpoint's default order. May also be sent as a same-named request header.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "1-based page number, used together with \"pageSize\". Defaults to the first page. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Number of items per page, used together with \"page\". Too high values will be capped. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of items to skip, used together with \"take\" as an alternative to \"page\"/\"pageSize\". May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "take", "in": "query", "description": "Number of items to return, used together with \"skip\" as an alternative to \"page\"/\"pageSize\". Too high values will be capped. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkEditReadItemsModel" } } }, "required": true }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/OptionListFieldItemResource" } }, "page": { "type": [ "null", "integer" ] }, "pageSize": { "type": [ "null", "integer" ] }, "totalCount": { "type": "integer", "format": "int64" } }, "description": "A paged/collection response envelope." }, { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ClassificationListFieldItemResource" } }, "page": { "type": [ "null", "integer" ] }, "pageSize": { "type": [ "null", "integer" ] }, "totalCount": { "type": "integer", "format": "int64" } }, "description": "A paged/collection response envelope." }, { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/UserListFieldItemResource" } }, "page": { "type": [ "null", "integer" ] }, "pageSize": { "type": [ "null", "integer" ] }, "totalCount": { "type": "integer", "format": "int64" } }, "description": "A paged/collection response envelope." }, { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroupListFieldItemResource" } }, "page": { "type": [ "null", "integer" ] }, "pageSize": { "type": [ "null", "integer" ] }, "totalCount": { "type": "integer", "format": "int64" } }, "description": "A paged/collection response envelope." } ] } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/record/{recordId}/downloadagreement/{contentId}/acceptance": { "post": { "tags": [ "Record" ], "summary": "Accept the download agreement for a record", "description": "### Examples\n\nAccepting a record's download agreement\n\nConfirms the logged-in user's acceptance of the terms in their language version of the agreement.\n\n```http\nPOST /record/8735a5a3e75a4bc0a2a1a3cd0069b669/downloadagreement/135/acceptance\n```", "operationId": "createRecordDownloadagreementAcceptanceByRecordIdAndContentId", "parameters": [ { "name": "recordId", "in": "path", "description": "id of the record", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "contentId", "in": "path", "description": "id of the download agreement's content", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Success" }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/record/{recordId}/field/{fieldId}/sanitization": { "post": { "tags": [ "Record" ], "summary": "Sanitize an HTML field value, stripping any markup not on the allowed tag/attribute list", "operationId": "createRecordFieldSanitizationByRecordIdAndFieldId", "parameters": [ { "name": "recordId", "in": "path", "description": "id of the record", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "fieldId", "in": "path", "description": "id of the field", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SanitizeFieldHtmlCommand" } } }, "required": true }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SanitizeFieldHtmlResultNonResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/record/{recordId}/field/{fieldId}/validation": { "post": { "tags": [ "Record" ], "summary": "Validate an HTML field value against the allowed tag/attribute list", "operationId": "createRecordFieldValidationByRecordIdAndFieldId", "parameters": [ { "name": "recordId", "in": "path", "description": "id of the record", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "fieldId", "in": "path", "description": "id of the field", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidateFieldHtmlCommand" } } }, "required": true }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidateFieldHtmlResultNonResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/rendition/{renditionId}": { "get": { "tags": [ "Rendition" ], "summary": "Read a rendition", "operationId": "getRenditionByRenditionId", "parameters": [ { "name": "renditionId", "in": "path", "description": "id of the rendition", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/OriginalRenditionResource" }, { "$ref": "#/components/schemas/PresetRenditionResource" }, { "$ref": "#/components/schemas/TrimRenditionResource" }, { "$ref": "#/components/schemas/CropRenditionResource" }, { "$ref": "#/components/schemas/CustomRenditionResource" } ] } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/rendition/{renditionId}/publiclinks": { "get": { "tags": [ "Rendition" ], "summary": "Read the public links for the rendition", "operationId": "getRenditionPubliclinksByRenditionId", "parameters": [ { "name": "renditionId", "in": "path", "description": "id of the rendition", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "$ref": "#/components/mediaTypes/PublicLinkCollectionResourceJson" }, "application/hal+json": { "$ref": "#/components/mediaTypes/PublicLinkCollectionResourceHal" } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/rule/{ruleId}": { "get": { "tags": [ "Rule" ], "summary": "Read a rule", "description": "### Examples\n\nSearching for a single rule\n\n```http\nGET /rule/c590b5d487d54b878619a7fc00cce3e6\n```", "operationId": "getRuleByRuleId", "parameters": [ { "name": "ruleId", "in": "path", "description": "id of the rule", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RuleResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "put": { "tags": [ "Rule" ], "summary": "Edit an existing rule", "operationId": "updateRuleByRuleId", "parameters": [ { "name": "ruleId", "in": "path", "description": "id of the rule", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RuleEditCommand" }, "example": { "name": "updated name of a rule", "enabled": "true", "includeDraftRecords": "false", "target": "fieldgroup", "trigger": "WhenSavedOrDeleted", "conditions": { "addOrUpdate": [ { "ConditionType": "ClassificationLinked", "index": 2, "directLinkOnly": false, "ClassificationId": "30b92c87-7b43-4a84-89eb-a81300fae78d" }, { "ConditionType": "Reference", "reference": "" } ], "remove": [ 1 ] }, "actions": { "addOrUpdate": [ { "index": 0, "ActionType": "Reference", "reference": "", "executionTime": "Delayed" }, { "ActionType": "Reference", "reference": "" }, { "ActionType": "ClassifyRecord", "gettingType": "Specified", "classificationId": "55b92c87-7b43-4a84-89eb-a81300fae7aa" }, { "actionType": "ClassifyRecord", "gettingType": "CalculatedByReference", "identifierType": "NamePath", "reference": "" }, { "actionType": "ClassifyRecord", "gettingType": "CalculatedByReference", "identifierType": "Identifier", "reference": "" }, { "ActionType": "UnclassifyRecord", "gettingType": "Specified", "classificationIds": [ "55b92c87-7b43-4a84-89eb-a81300fae7aa", "66c03d98-8c54-5b95-90fc-b92411gbf8ba" ] }, { "actionType": "UnclassifyRecord", "gettingType": "CalculatedByReference", "identifierType": "NamePath", "reference": "" }, { "actionType": "UnclassifyRecord", "gettingType": "CalculatedByReference", "identifierType": "Identifier", "reference": "" } ], "remove": [ 1, 3 ] } } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "delete": { "tags": [ "Rule" ], "summary": "Delete the specified rule", "description": "### Examples\n\nDeleting a rule\n\n```http\nDELETE /rule/9d88d5ece8c345e6a669a82000b10761\n```", "operationId": "deleteRuleByRuleId", "parameters": [ { "name": "ruleId", "in": "path", "description": "id of the rule", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/rules": { "get": { "tags": [ "Rule" ], "summary": "Read a collection of rules", "description": "### Examples\n\nSearching for rules (HTTP headers)\n\n```http\nGET /rules\naccept: application/hal+json\nfilter: ModifiedOn in today\nsort: modifiedOn\npage: 1\npageSize: 20\n```\n\nSearching for rules (query string parameters)\n\n```http\nGET /rules?filter=ModifiedOn+in+today&sort=createdon&page=1&pagesize=10\n```\n\nSearching for rules (headers + query string combined)\n\n```http\nGET /rules?filter=ModifiedOn+in+today&sort=createdon\npage: 1\npageSize: 20\n```", "operationId": "getRules", "parameters": [ { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "A filter expression restricting which items are returned, e.g. \"ModifiedOn in today\". Omit to return all items the caller may see. The query parameter is the canonical location for this filter; the same value may alternatively be sent as a same-named request header.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "The property to sort by, optionally suffixed to control direction, e.g. \"createdOn\". Omit for the endpoint's default order. May also be sent as a same-named request header.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "1-based page number, used together with \"pageSize\". Defaults to the first page. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Number of items per page, used together with \"page\". Too high values will be capped. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of items to skip, used together with \"take\" as an alternative to \"page\"/\"pageSize\". May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "take", "in": "query", "description": "Number of items to return, used together with \"skip\" as an alternative to \"page\"/\"pageSize\". Too high values will be capped. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/RuleResource" } }, "page": { "type": [ "null", "integer" ] }, "pageSize": { "type": [ "null", "integer" ] }, "totalCount": { "type": "integer", "format": "int64" } }, "description": "A paged/collection response envelope." } }, "application/hal+json": { "schema": { "required": [ "_links" ], "type": "object", "properties": { "_links": { "type": "object", "properties": { "self": { "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/RuleResource" } }, "page": { "type": [ "null", "integer" ] }, "pageSize": { "type": [ "null", "integer" ] }, "totalCount": { "type": "integer", "format": "int64" } }, "description": "A paged/collection response envelope." } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "post": { "tags": [ "Rule" ], "summary": "Create a new rule", "operationId": "createRules", "parameters": [ { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RuleCreateCommand" }, "example": { "name": "Rule Name", "enabled": "true", "includeDraftRecords": "false", "target": "Record", "trigger": "WhenSavedOrDeleted", "Conditions": { "AddOrUpdate": [ { "Reference": "", "ConditionType": "Reference" }, { "Reference": "", "ConditionType": "Reference" } ] }, "actions": { "addOrUpdate": [ { "ActionType": "Reference", "Reference": "", "ExecutionTime": "Immediately" }, { "ActionType": "RefreshFiles" }, { "ActionType": "ClassifyRecord", "gettingType": "Specified", "classificationId": "55b92c87-7b43-4a84-89eb-a81300fae7aa" }, { "actionType": "ClassifyRecord", "gettingType": "CalculatedByReference", "identifierType": "NamePath", "reference": "" }, { "actionType": "ClassifyRecord", "gettingType": "CalculatedByReference", "identifierType": "Identifier", "reference": "" }, { "ActionType": "UnclassifyRecord", "gettingType": "Specified", "classificationId": "55b92c87-7b43-4a84-89eb-a81300fae7aa" }, { "actionType": "UnclassifyRecord", "gettingType": "CalculatedByReference", "identifierType": "NamePath", "reference": "" }, { "actionType": "UnclassifyRecord", "gettingType": "CalculatedByReference", "identifierType": "Identifier", "reference": "" } ] } } } }, "required": true }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatedResourceId" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/rule/{ruleId}/actions": { "get": { "tags": [ "Rule" ], "summary": "Read the actions of the rule", "operationId": "getRuleActionsByRuleId", "parameters": [ { "name": "ruleId", "in": "path", "description": "id of the rule", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RuleActionCollectionResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/rule/{ruleId}/conditions": { "get": { "tags": [ "Rule" ], "summary": "Read the conditions of the rule", "operationId": "getRuleConditionsByRuleId", "parameters": [ { "name": "ruleId", "in": "path", "description": "id of the rule", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RuleConditionCollectionResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/rule/{ruleId}/createdby": { "get": { "tags": [ "Rule" ], "summary": "Read the user who created the rule", "operationId": "getRuleCreatedbyByRuleId", "parameters": [ { "name": "ruleId", "in": "path", "description": "id of the rule", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/rule/{ruleId}/modifiedby": { "get": { "tags": [ "Rule" ], "summary": "Read the user who last modified the rule", "operationId": "getRuleModifiedbyByRuleId", "parameters": [ { "name": "ruleId", "in": "path", "description": "id of the rule", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/search/classifications": { "post": { "tags": [ "Search" ], "summary": "Search classifications", "description": "### Examples\n\nAdvanced searching for classifications\n\nThe `/search/classifications` endpoint supports only the `searchExpression` and `logRequest` parameters (no facets). The result shape is similar to a regular classification search.", "operationId": "createSearchClassifications", "parameters": [ { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "The property to sort by, optionally suffixed to control direction, e.g. \"createdOn\". Omit for the endpoint's default order. May also be sent as a same-named request header.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "1-based page number, used together with \"pageSize\". Defaults to the first page. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Number of items per page, used together with \"page\". Too high values will be capped. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of items to skip, used together with \"take\" as an alternative to \"page\"/\"pageSize\". May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "take", "in": "query", "description": "Number of items to return, used together with \"skip\" as an alternative to \"page\"/\"pageSize\". Too high values will be capped. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClassificationSearchModel" }, "example": { "searchExpression": { "disabledKeywords": null, "supportWildcards": false, "defaultLogicalOperator": "AND", "languages": [ "c2bd4f9bbb954bcb80c31e924c9c26dc" ], "expression": "NamePath = ?", "parameters": [ "/Goods/Phones" ], "namedParameters": { }, "subExpressions": null }, "logRequest": true } } }, "required": true }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ClassificationResource" } }, "page": { "type": [ "null", "integer" ] }, "pageSize": { "type": [ "null", "integer" ] }, "totalCount": { "type": "integer", "format": "int64" } }, "description": "A paged/collection response envelope." } }, "application/hal+json": { "schema": { "required": [ "_links" ], "type": "object", "properties": { "_links": { "type": "object", "properties": { "self": { "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ClassificationResource" } }, "page": { "type": [ "null", "integer" ] }, "pageSize": { "type": [ "null", "integer" ] }, "totalCount": { "type": "integer", "format": "int64" } }, "description": "A paged/collection response envelope." } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/search/images": { "post": { "tags": [ "Search" ], "summary": "Start an image similarity search job", "operationId": "createSearchImages", "parameters": [ { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImageSearchCommand" } } }, "required": true }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatedResourceId" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/search/phrase-suggestions": { "post": { "tags": [ "Search" ], "summary": "Get phrase-level search suggestions", "operationId": "createSearchPhrase-suggestions", "parameters": [ { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PhraseSuggestionRequestModel" } } }, "required": true }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PhraseSuggestionsNonResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/search/records": { "post": { "tags": [ "Search" ], "summary": "Search records", "description": "### Examples\n\nAdvanced searching for records\n\nFor more complex search queries than the `filter` parameter supports, use this endpoint. The `facets` array lets you compute aggregated counts alongside the search results - see the request/response schemas for the full set of supported facet types and their parameters.\n\n**Some remarks:**\n\n- Due to the way search works, the returned `totalCount` is an approximation and might not be the same as the number of returned search results. The retrieved facet count is also an approximation.\n- Facet values with a count of 0 are omitted from the reply, even if they are directly specified, e.g. as explicit values. If the consuming application needs to display facet values with a count of 0, it should keep track of them internally.\n- The number of facets that can be returned per request is limited to 12. If more than 12 facets are submitted, the list is truncated - the search engine only includes the first 12, and the ignored facet names are listed in the response's `truncatedFacets` property.", "operationId": "createSearchRecords", "parameters": [ { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "The property to sort by, optionally suffixed to control direction, e.g. \"createdOn\". Omit for the endpoint's default order. May also be sent as a same-named request header.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "1-based page number, used together with \"pageSize\". Defaults to the first page. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Number of items per page, used together with \"page\". Too high values will be capped. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of items to skip, used together with \"take\" as an alternative to \"page\"/\"pageSize\". May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "take", "in": "query", "description": "Number of items to return, used together with \"skip\" as an alternative to \"page\"/\"pageSize\". Too high values will be capped. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordSearchModel" }, "examples": { "advanced-search-records": { "summary": "Faceting by NumericFieldRangeFacet, with response facet counts", "value": { "searchExpression": { "disabledKeywords": null, "supportWildcards": false, "defaultLogicalOperator": "AND", "languages": [ "c2bd4f9bbb954bcb80c31e924c9c26dc" ], "expression": "CreatedOn < 2015-09-29T12:24:22.287Z", "parameters": [ ], "namedParameters": { }, "subExpressions": null }, "facets": [ { "name": "price", "type": "numericFieldRange", "fieldId": "b7a3a79f-f403-4af3-9f4c-a3cd0069b2c4", "rangeStart": 0, "rangeEnd": 1000, "spans": [ 1, 2 ] } ], "logRequest": true } }, "facet-classification-facet": { "summary": "Faceting by ClassificationFacet", "value": { "searchExpression": { "expression": "ContentType='Asset'" }, "facets": [ { "name": "brand", "type": "classification", "facetRootId": "BCAEDD3B-DA09-4DED-817D-D92D335158AF", "options": [ "FacetRoot", "Children" ], "directLinkedOnly": true, "maximumFacetValues": 20 } ] } }, "facet-classification-list-field-facet": { "summary": "Faceting by ClassificationListFieldFacet", "value": { "searchExpression": { "expression": "ContentType='Asset'" }, "facets": [ { "name": "region", "type": "classificationListField", "fieldId": "9336117A-047E-4C76-BCBC-0A4A7316F8A6", "explicitValues": [ "42A9A761-D22B-4694-A196-618282B64957", "9F4205FD-4977-488C-A8E4-6FB4D6B09AC5" ] } ] } }, "facet-content-type-facet": { "summary": "Faceting by ContentTypeFacet", "value": { "searchExpression": { "expression": "ContentType='Asset'" }, "facets": [ { "name": "Content Types", "type": "contentType", "rootContentType": "Image", "maximumFacetValues": 20, "directLinkedOnly": true } ] } }, "facet-created-by-facet": { "summary": "Faceting by CreatedByFacet", "value": { "searchExpression": { "expression": "ContentType='Asset'" }, "facets": [ { "name": "creator", "type": "createdBy", "explicitValues": [ "BCAEDD3B-DA09-4DED-817D-D92D335158AF", "20099504-462F-408F-A5F8-51CB140A7A43" ], "maximumFacetValues": 12 } ] } }, "facet-created-on-facet": { "summary": "Faceting by CreatedOnFacet", "value": { "searchExpression": { "expression": "ContentType='Asset'" }, "facets": [ { "name": "date of creation", "type": "createdOn", "rangeStart": "2014-05-15T10:41:19.51Z", "rangeEnd": "2015-05-15T10:41:19.51Z", "spans": [ { "dateTimeUnit": "days", "value": 7 }, { "dateTimeUnit": "months", "value": 1 } ], "boundaries": [ "Lower", "Upper" ] } ] } }, "facet-date-field-range-facet": { "summary": "Faceting by DateFieldRangeFacet", "value": { "searchExpression": { "expression": "ContentType='Asset'" }, "facets": [ { "name": "productionDate", "type": "dateFieldRange", "fieldId": "E63E2645-BC54-4D64-AEE6-FC5458DB6AAE", "rangeStart": "2014-05-15T00:00:00.00Z", "rangeEnd": "2015-05-15T00:00:00.00Z", "spans": [ { "dateUnit": "days", "value": 7 }, { "dateUnit": "months", "value": 1 } ], "boundaries": [ "Lower", "Upper" ] } ] } }, "facet-date-time-field-range-facet": { "summary": "Faceting by DateTimeFieldRangeFacet", "value": { "searchExpression": { "expression": "ContentType='Asset'" }, "facets": [ { "name": "productionDateTime", "type": "dateTimeFieldRange", "fieldId": "53092CEF-A15C-42EE-AA89-369D9A0E1E1B", "rangeStart": "2014-05-15T10:41:19.51Z", "rangeEnd": "2015-05-15T10:41:19.51Z", "spans": [ { "dateTimeUnit": "hours", "value": 4 }, { "dateTimeUnit": "days", "value": 1 } ], "boundaries": [ "Lower", "Upper" ] } ] } }, "facet-file-type-facet": { "summary": "Faceting by FileTypeFacet", "value": { "searchExpression": { "expression": "ContentType='Asset'" }, "facets": [ { "name": "type of file", "type": "fileType", "explicitValues": [ "BCAEDD3B-DA09-4DED-817D-D92D335158AF", "20099504-462F-408F-A5F8-51CB140A7A43" ], "maximumFacetValues": 9 } ] } }, "facet-modified-by-facet": { "summary": "Faceting by ModifiedByFacet", "value": { "searchExpression": { "expression": "ContentType='Asset'" }, "facets": [ { "name": "modifier", "type": "modifiedBy", "explicitValues": [ "BCAEDD3B-DA09-4DED-817D-D92D335158AF", "20099504-462F-408F-A5F8-51CB140A7A43" ], "maximumFacetValues": 9 } ] } }, "facet-modified-on-facet": { "summary": "Faceting by ModifiedOnFacet", "value": { "searchExpression": { "expression": "ContentType='Asset'" }, "facets": [ { "name": "date of modification", "type": "modifiedOn", "rangeStart": "2014-05-15T10:41:19.51Z", "rangeEnd": "2015-05-15T10:41:19.51Z", "spans": [ { "dateTimeUnit": "days", "value": 7 }, { "dateTimeUnit": "months", "value": 1 } ], "boundaries": [ "Lower", "Upper" ] } ] } }, "facet-numeric-field-facet": { "summary": "Faceting by NumericFieldFacet", "value": { "searchExpression": { "expression": "ContentType='Asset'" }, "facets": [ { "name": "price", "type": "numericField", "fieldId": "EE85EBFD-E46E-44DF-AE44-90A6A4FEC9D7", "explicitValues": [ 10, 99.9, 12, 27 ], "maximumFacetValues": 9 } ] } }, "facet-option-list-field-facet": { "summary": "Faceting by OptionListFieldFacet", "value": { "searchExpression": { "expression": "ContentType='Asset'" }, "facets": [ { "name": "choice", "type": "optionListField", "fieldId": "40A5C3E5-518A-4368-823D-CD289723F78F", "explicitValues": [ "BCAEDD3B-DA09-4DED-817D-D92D335158AF", "20099504-462F-408F-A5F8-51CB140A7A43" ] } ] } }, "facet-text-field-facet": { "summary": "Faceting by TextFieldFacet", "value": { "searchExpression": { "expression": "ContentType='Asset'" }, "facets": [ { "name": "color", "type": "textField", "fieldId": "40A5C3E5-518A-4368-823D-CD289723F78F", "explicitValues": [ "green", "yellow", "blue" ], "caseSensitive": false } ] } }, "facet-text-list-field-facet": { "summary": "Faceting by TextListFieldFacet", "value": { "searchExpression": { "expression": "ContentType='Asset'" }, "facets": [ { "name": "status", "type": "textListField", "fieldId": "CDB72463-2056-4A2D-8903-54D7A1DBBBD0", "explicitValues": [ "available", "out of stock" ] } ] } }, "facet-time-field-range-facet": { "summary": "Faceting by TimeFieldRangeFacet", "value": { "searchExpression": { "expression": "ContentType='Asset'" }, "facets": [ { "name": "productionTime", "type": "timeFieldRange", "fieldId": "53092CEF-A15C-42EE-AA89-369D9A0E1E1B", "rangeStart": "10:41:19", "rangeEnd": "18:41:19", "spans": [ "00:15:00", "00:30:00", "01:00:00" ], "boundaries": [ "Lower", "Upper" ] } ] } }, "facet-date-field-range-filter": { "summary": "Faceting by DateFieldRangeFilter", "value": { "searchExpression": { "expression": "ContentType='Asset'" }, "facets": [ { "name": "expirationDate", "type": "dateFieldRangeFilter", "fieldId": "98C9974E-260C-4399-866C-AF330057B0A4", "filters": [ { "rangeStart": "2022-08-24T00:00:00.00Z", "rangeEnd": "2022-08-29T00:00:00.00Z" } ] } ] } }, "facet-numeric-field-range-filter": { "summary": "Faceting by NumericFieldRangeFilter", "value": { "searchExpression": { "expression": "ContentType='Asset'" }, "facets": [ { "name": "Test Numeric", "type": "numericFieldRangeFilter", "fieldId": "b0a96b8a-243b-475e-ac2d-afaf009d81df", "filters": [ { "rangeStart": 1.5, "rangeEnd": 612.155 } ] } ] } } } } }, "required": true }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "title": "Search response resource", "type": "object", "properties": { "facets": { "type": "array", "items": { "$ref": "#/components/schemas/FacetNonResource" }, "description": "The collection of facets. Facet values with a count of 0 are omitted, even if they were directly requested, e.g. as explicitValues - if you need to display facet values with a count of 0, keep track of them on your side." }, "truncatedFacets": { "type": "array", "items": { "type": "string" }, "description": "Names of facets that were dropped from this response because more than 12 facets were requested - the search engine only computes the first 12 facets per request." }, "nextCursor": { "type": [ "null", "string" ], "description": "Opaque cursor for the next page. Pass back as cursor in the next request to continue from exactly this position at constant cost per page, regardless of depth. Null when this is the last page or the result set is empty." }, "pageNumber": { "type": [ "null", "integer" ], "description": "The current page of this paged collection.", "format": "int32" }, "pageSize": { "type": [ "null", "integer" ], "description": "The current page size of this paged collection.", "format": "int32" }, "skip": { "type": [ "null", "integer" ], "description": "The current skip size of this paged collection.", "format": "int32" }, "take": { "type": [ "null", "integer" ], "description": "The current take size of this paged collection.", "format": "int32" }, "totalCount": { "type": "integer", "description": "The total count of items in this paged collection, not just on the current page.", "format": "int64" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/RecordResource" }, "description": "One page of this paged collection, which is a subcollection of the complete collection." } }, "description": "Represents a complete search response, including a paged collection of hits and optional facet information. Searching is done in 2 steps: first ElasticSearch is queried to get a list of matching IDs, then those IDs are used to query the Aprimo DAM database. Because of this, totalCount is an approximation and might not match the number of returned search results, and facet counts are also approximate." }, "example": { "facets": [ { "name": "price", "values": [ { "key": { "from": 0, "to": 1 }, "count": 645 }, { "key": { "from": 1, "to": 3 }, "count": 2945 } ] } ], "page": 1, "pageSize": 50, "totalCount": 38610, "items": [ ] } }, "application/hal+json": { "schema": { "required": [ "_links" ], "$ref": "#/components/schemas/SearchResponseResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/search/records/suggestions": { "post": { "tags": [ "Search" ], "summary": "Get field-value autocomplete suggestions", "description": "### Examples\n\nField-value autocomplete suggestions\n\nIssue a `POST` request with the input text, the languages, and the fields to generate suggestions from. Your Aprimo DAM installation must be configured so that the requested fields are included in the suggestion search engine indexing, via the `.enterpriseSearchSuggestionConfiguration` system setting.\n\nThe response contains a list of suggestions per input language. Each suggestion contains the matched text and a score estimating how well the input was matched.", "operationId": "createSearchRecordsSuggestions", "parameters": [ { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuggestionRequestModel" }, "example": { "input": "TRY", "languageids": [ "c2bd4f9b-bb95-4bcb-80c3-1e924c9c26dc" ], "fieldids": [ "72de5be85e4b453e867ea3cd0069b0f4" ], "fuzziness": 1, "numberOfSuggestions": 10 } } }, "required": true }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LanguageSuggestionsNonResource" } }, "example": [ { "languageId": "c2bd4f9bbb954bcb80c31e924c9c26dc", "suggestions": [ { "text": "TRYGG", "score": 17.31806755065918 }, { "text": "EKBY VALTER/ EKBY TRYGGVE", "score": 8.439911842346191 } ] } ] } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/searchindex": { "get": { "tags": [ "Search index" ], "summary": "Read the search index status", "description": "### Examples\n\nReading the search index state\n\n```http\nGET /searchindex\n```", "operationId": "getSearchindex", "parameters": [ { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchIndexResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "put": { "tags": [ "Search index" ], "summary": "Trigger a rebuild of the search index", "operationId": "updateSearchindex", "parameters": [ { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSearchIndexCommand" }, "example": { "rebuildScheduled": true } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/setting/{settingName}": { "get": { "tags": [ "Setting" ], "summary": "Read a setting", "description": "### Examples\n\nReading a setting\n\nIf the setting is found, a resource is returned containing the name and the value of the setting.\n\nIf the setting was not found, the API call will fail with a **404 Not found** HTTP status code.\n\n```http\nGET /setting/.defaultRecordTitleField\n```\n\nReading a setting from a specific scope\n\nIf the setting is found, within a given scope, a resource is returned containing the name and the value of the setting.\n\nIf the setting was not found, the API call will fail with a **404 Not found** HTTP status code.\n\nTo access a setting through the Rest API, you must have the **Role required to change** which is defined on the setting definition.\n\n```http\nGET /setting/.defaultRecordTitleField?scope=usergroup&scopeId=d4889b57-af11-4da9-aba1-c96d1b6a22ec\n```", "operationId": "getSettingBySettingName", "parameters": [ { "name": "settingName", "in": "path", "description": "name of the setting", "required": true, "schema": { "type": "string" } }, { "name": "scope", "in": "query", "description": "scope of the setting", "schema": { "type": "string" } }, { "name": "scopeId", "in": "query", "description": "id within the scope", "schema": { "type": [ "null", "string" ], "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingResource" }, "examples": { "read": { "summary": "Reading a setting", "value": { "_links": { "self": { "href": "/setting/.defaultRecordTitleField" } }, "name": ".defaultRecordTitleField", "value": "DisplayTitle" } }, "read-scoped": { "summary": "Reading a setting from a specific scope", "value": { "_links": { "self": { "href": "/setting/.defaultRecordTitleField?scope=usergroup&scopeId=d4889b57-af11-4da9-aba1-c96d1b6a22ec" } }, "name": ".defaultRecordTitleField", "value": "DisplayTitle" } } } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "put": { "tags": [ "Setting" ], "summary": "Set the value of an existing setting for the specified scope", "description": "### Examples\n\nRules for passing parameters", "operationId": "updateSettingBySettingName", "parameters": [ { "name": "settingName", "in": "path", "description": "name of the setting", "required": true, "schema": { "type": "string" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingEditCommand" }, "example": { "name": ".defaultRecordTitleField", "value": "DisplayTitle", "scope": "UserGroup", "scopeId": "1ED74A99-84CD-4A9C-BFEB-A4D000EC3275" } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/settings": { "get": { "tags": [ "Setting" ], "summary": "Read a collection of settings", "description": "### Examples\n\nGetting multiple settings\n\nUse the \"**names**\" query parameter to specify a comma-separated list of setting names.\n\nFor example:\n\nThis request will not fail for the cases when a single setting fetch will:\n- When a setting is not found: the missing setting will be omitted from the response.\n- When a setting is not whitelisted and the user is not in the ADAM Administrator user group: it will not be returned either.\n- When the user doesn't have the Role required to change: the aggregated value for the current requestor will be returned using the ADAM setting value fallback mechanism.\n- When a setting is a **Role Setting**: it will not be returned in the response.\n- If, due to all the specifics above, none of requested settings is returned, the response will simply be an empty collection (but not 404 not found).\n\n```http\nGET /settings?names=.recordFieldViewList,.userFieldViewList\nAccept: application/hal+json\n```", "operationId": "getSettings", "parameters": [ { "name": "names", "in": "query", "description": "Comma separated list of setting names.", "schema": { "type": "string" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "1-based page number, used together with \"pageSize\". Defaults to the first page. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Number of items per page, used together with \"page\". Too high values will be capped. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of items to skip, used together with \"take\" as an alternative to \"page\"/\"pageSize\". May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "take", "in": "query", "description": "Number of items to return, used together with \"skip\" as an alternative to \"page\"/\"pageSize\". Too high values will be capped. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "title": "Setting collection resource", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/SettingResource" }, "description": "A collection of resource items." } }, "description": "Representation of a collection of settings" } }, "application/hal+json": { "schema": { "required": [ "_links" ], "$ref": "#/components/schemas/SettingCollectionResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/settingcategory/{settingcategoryId}": { "get": { "tags": [ "Setting category" ], "summary": "Read a setting category resource", "operationId": "getSettingcategoryBySettingcategoryId", "parameters": [ { "name": "settingcategoryId", "in": "path", "description": "id of the setting category", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingCategoryResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "put": { "tags": [ "Setting category" ], "summary": "Edit an existing setting category resource", "operationId": "updateSettingcategoryBySettingcategoryId", "parameters": [ { "name": "settingcategoryId", "in": "path", "description": "id of the setting category", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingCategoryEditCommand" }, "example": { "name": "Just for DEMO 2", "labels": [ { "languageId": "C2BD4F9B-BB95-4BCB-80C3-1E924C9C26DC", "value": "My setting category Name In English" }, { "languageId": "5d557ae8-fd16-4dbb-a9d9-a80400dfa639", "value": "My setting category Name In German" } ], "tag": "test tag" } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "delete": { "tags": [ "Setting category" ], "summary": "Delete the specified setting category resource", "description": "### Examples\n\nDeleting a setting category\n\n```http\nDELETE /settingcategory/e44ce6ba-f0a9-4a60-888a-e4bdd4b24bf0\n```", "operationId": "deleteSettingcategoryBySettingcategoryId", "parameters": [ { "name": "settingcategoryId", "in": "path", "description": "id of the setting category", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/settingcategories": { "get": { "tags": [ "Setting category" ], "summary": "Read a collection of setting categories", "description": "### Examples\n\nSearching for setting categories (HTTP headers)\n\n```http\nGET /settingcategories\nAccept: application/hal+json\nFilter: ModifiedOn in today\nSort: createdon\nPage: 1\nPageSize: 20\n```\n\nSearching for setting categories (query string parameters)\n\n```http\nGET /settingcategories?filter=ModifiedOn+in+today&sort=createdon&page=1&pagesize=20\n```\n\nSearching for setting categories (headers + query string combined)\n\n```http\nGET /settingcategories?filter=ModifiedOn+in+today&sort=createdon\nPage: 1\nPageSize: 20\n```", "operationId": "getSettingcategories", "parameters": [ { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "A filter expression restricting which items are returned, e.g. \"ModifiedOn in today\". Omit to return all items the caller may see. The query parameter is the canonical location for this filter; the same value may alternatively be sent as a same-named request header.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "The property to sort by, optionally suffixed to control direction, e.g. \"createdOn\". Omit for the endpoint's default order. May also be sent as a same-named request header.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "1-based page number, used together with \"pageSize\". Defaults to the first page. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Number of items per page, used together with \"page\". Too high values will be capped. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of items to skip, used together with \"take\" as an alternative to \"page\"/\"pageSize\". May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "take", "in": "query", "description": "Number of items to return, used together with \"skip\" as an alternative to \"page\"/\"pageSize\". Too high values will be capped. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/SettingCategoryResource" } }, "page": { "type": [ "null", "integer" ] }, "pageSize": { "type": [ "null", "integer" ] }, "totalCount": { "type": "integer", "format": "int64" } }, "description": "A paged/collection response envelope." } }, "application/hal+json": { "schema": { "required": [ "_links" ], "type": "object", "properties": { "_links": { "type": "object", "properties": { "self": { "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/SettingCategoryResource" } }, "page": { "type": [ "null", "integer" ] }, "pageSize": { "type": [ "null", "integer" ] }, "totalCount": { "type": "integer", "format": "int64" } }, "description": "A paged/collection response envelope." } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "post": { "tags": [ "Setting category" ], "summary": "Create a new setting category resource", "operationId": "createSettingcategories", "parameters": [ { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingCategoryCreateCommand" }, "example": { "name": "Just for DEMO", "labels": { "addOrUpdate": [ { "languageId": "c2bd4f9b-bb95-4bcb-80c3-1e924c9c26dc", "value": "Just for DEMO" } ] }, "tag": "test tag" } } }, "required": true }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatedResourceId" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/settingdefinition/{settingdefinitionId}": { "get": { "tags": [ "Setting definition" ], "summary": "Read a settingdefinition resource", "operationId": "getSettingdefinitionBySettingdefinitionId", "parameters": [ { "name": "settingdefinitionId", "in": "path", "description": "id of the settingdefinition", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/BooleanSettingDefinitionResource" }, { "$ref": "#/components/schemas/DateTimeSettingDefinitionResource" }, { "$ref": "#/components/schemas/EncryptedTextSettingDefinitionResource" }, { "$ref": "#/components/schemas/NumericSettingDefinitionResource" }, { "$ref": "#/components/schemas/ReferenceSettingDefinitionResource" }, { "$ref": "#/components/schemas/RoleSettingDefinitionResource" }, { "$ref": "#/components/schemas/TextSettingDefinitionResource" }, { "$ref": "#/components/schemas/XmlSettingDefinitionResource" }, { "$ref": "#/components/schemas/DefSchemaSettingDefinitionResource" } ] } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "put": { "tags": [ "Setting definition" ], "summary": "Edit an existing settingdefinition resource", "operationId": "updateSettingdefinitionBySettingdefinitionId", "parameters": [ { "name": "settingdefinitionId", "in": "path", "description": "id of the settingdefinition", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingDefinitionEditCommand" }, "example": { "dataType": "text", "name": "Name might be changed", "allowSystemSetting": true, "categoryId": "1fd3e09b1e2f40888e419eb4d6d31a38", "regularExpression": "[0-9]*" } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "delete": { "tags": [ "Setting definition" ], "summary": "Delete the specified settingdefinition resource", "description": "### Examples\n\nDeleting a setting definition\n\n```http\nDELETE /settingdefinition/495bb521-1061-40e6-8f74-45a31d3497f9\n```", "operationId": "deleteSettingdefinitionBySettingdefinitionId", "parameters": [ { "name": "settingdefinitionId", "in": "path", "description": "id of the settingdefinition", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/settingdefinitions": { "get": { "tags": [ "Setting definition" ], "summary": "Read a collection of settingdefinitions", "description": "### Examples\n\nSearching for setting definitions (HTTP headers)\n\n```http\nGET /settingdefinitions\nAccept: application/hal+json\nFilter: ModifiedOn in today\nSort: createdon\nPage: 1\nPageSize: 20\n```\n\nSearching for setting definitions (query string parameters)\n\n```http\nGET /settingdefinitions?filter=ModifiedOn+in+today&sort=createdon&page=1&pagesize=20\n```\n\nSearching for setting definitions (headers + query string combined)\n\n```http\nGET /settingdefinitions?filter=ModifiedOn+in+today&sort=createdon\nPage: 1\nPageSize: 20\n```", "operationId": "getSettingdefinitions", "parameters": [ { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "A filter expression restricting which items are returned, e.g. \"ModifiedOn in today\". Omit to return all items the caller may see. The query parameter is the canonical location for this filter; the same value may alternatively be sent as a same-named request header.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "The property to sort by, optionally suffixed to control direction, e.g. \"createdOn\". Omit for the endpoint's default order. May also be sent as a same-named request header.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "1-based page number, used together with \"pageSize\". Defaults to the first page. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Number of items per page, used together with \"page\". Too high values will be capped. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of items to skip, used together with \"take\" as an alternative to \"page\"/\"pageSize\". May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "take", "in": "query", "description": "Number of items to return, used together with \"skip\" as an alternative to \"page\"/\"pageSize\". Too high values will be capped. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/BooleanSettingDefinitionResource" }, { "$ref": "#/components/schemas/DateTimeSettingDefinitionResource" }, { "$ref": "#/components/schemas/EncryptedTextSettingDefinitionResource" }, { "$ref": "#/components/schemas/NumericSettingDefinitionResource" }, { "$ref": "#/components/schemas/ReferenceSettingDefinitionResource" }, { "$ref": "#/components/schemas/RoleSettingDefinitionResource" }, { "$ref": "#/components/schemas/TextSettingDefinitionResource" }, { "$ref": "#/components/schemas/XmlSettingDefinitionResource" }, { "$ref": "#/components/schemas/DefSchemaSettingDefinitionResource" } ] } }, "page": { "type": [ "null", "integer" ] }, "pageSize": { "type": [ "null", "integer" ] }, "totalCount": { "type": "integer", "format": "int64" } }, "description": "A paged/collection response envelope." } }, "application/hal+json": { "schema": { "required": [ "_links" ], "type": "object", "properties": { "_links": { "type": "object", "properties": { "self": { "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "items": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/BooleanSettingDefinitionResource" }, { "$ref": "#/components/schemas/DateTimeSettingDefinitionResource" }, { "$ref": "#/components/schemas/EncryptedTextSettingDefinitionResource" }, { "$ref": "#/components/schemas/NumericSettingDefinitionResource" }, { "$ref": "#/components/schemas/ReferenceSettingDefinitionResource" }, { "$ref": "#/components/schemas/RoleSettingDefinitionResource" }, { "$ref": "#/components/schemas/TextSettingDefinitionResource" }, { "$ref": "#/components/schemas/XmlSettingDefinitionResource" }, { "$ref": "#/components/schemas/DefSchemaSettingDefinitionResource" } ] } }, "page": { "type": [ "null", "integer" ] }, "pageSize": { "type": [ "null", "integer" ] }, "totalCount": { "type": "integer", "format": "int64" } }, "description": "A paged/collection response envelope." } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "post": { "tags": [ "Setting definition" ], "summary": "Create a new settingdefinition resource", "operationId": "createSettingdefinitions", "parameters": [ { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/BooleanSettingDefinitionCreateCommand" }, { "$ref": "#/components/schemas/DateTimeSettingDefinitionCreateCommand" }, { "$ref": "#/components/schemas/EncryptedTextSettingDefinitionCreateCommand" }, { "$ref": "#/components/schemas/NumericSettingDefinitionCreateCommand" }, { "$ref": "#/components/schemas/ReferenceSettingDefinitionCreateCommand" }, { "$ref": "#/components/schemas/RoleSettingDefinitionCreateCommand" }, { "$ref": "#/components/schemas/TextSettingDefinitionCreateCommand" }, { "$ref": "#/components/schemas/XmlSettingDefinitionCreateCommand" }, { "$ref": "#/components/schemas/DefSchemaSettingDefinitionCreateCommand" } ], "discriminator": { "propertyName": "dataType", "mapping": { "Boolean": "#/components/schemas/BooleanSettingDefinitionCreateCommand", "DateTime": "#/components/schemas/DateTimeSettingDefinitionCreateCommand", "EncryptedText": "#/components/schemas/EncryptedTextSettingDefinitionCreateCommand", "Numeric": "#/components/schemas/NumericSettingDefinitionCreateCommand", "Reference": "#/components/schemas/ReferenceSettingDefinitionCreateCommand", "Role": "#/components/schemas/RoleSettingDefinitionCreateCommand", "Text": "#/components/schemas/TextSettingDefinitionCreateCommand", "Xml": "#/components/schemas/XmlSettingDefinitionCreateCommand", "DefSchema": "#/components/schemas/DefSchemaSettingDefinitionCreateCommand" } } }, "examples": { "create": { "summary": "Creating a new setting definition (common attributes)", "value": { "dataType": "text", "name": "NewSettingdefinition", "categoryId": "categoryId", "allowAnonymousAccess": false, "allowSystemSetting": true, "allowSiteSetting": false, "allowUserSetting": false, "roleRequiredForChange": ".RoleChangeSystemSettings", "labels": [ { "languageId": "54DFBAA2-98A3-4480-A9B2-2AD582304E0B", "value": "New settingdefinition" } ], "tag": null, "webEditor": null, "helpUrl": null, "userGroupSettingMode": "None" } }, "create-boolean": { "summary": "Creating a boolean setting definition", "value": { "dataType": "boolean", "name": "BooleanSettingName", "allowSystemSetting": true, "categoryId": "1fd3e09b1e2f40888e419eb4d6d31a38", "defaultValue": true } }, "create-datetime": { "summary": "Creating a datetime setting definition", "value": { "dataType": "datetime", "name": "DateTimeSettingName", "allowSystemSetting": true, "categoryId": "1fd3e09b1e2f40888e419eb4d6d31a38", "defaultValue": "2017-10-30T12:36:25.397+02:00" } }, "create-encryptedtext": { "summary": "Creating an encrypted text setting definition", "value": { "dataType": "encryptedtext", "name": "EncryptedTextSettingName", "allowSystemSetting": true, "categoryId": "1fd3e09b1e2f40888e419eb4d6d31a38", "defaultValue": "Default Value", "regularExpression": ".*" } }, "create-numeric": { "summary": "Creating a numeric setting definition", "value": { "dataType": "numeric", "name": "NumericSettingName", "allowSystemSetting": true, "categoryId": "1fd3e09b1e2f40888e419eb4d6d31a38", "defaultValue": 1, "range": "1-255" } }, "create-reference": { "summary": "Creating a reference setting definition", "value": { "dataType": "reference", "name": "ReferenceSettingName", "allowSystemSetting": true, "defaultValue": "reference", "categoryId": "1fd3e09b1e2f40888e419eb4d6d31a38" } }, "create-role": { "summary": "Creating a role setting definition", "value": { "dataType": "role", "name": "RoleSettingName", "allowUserSetting": true, "categoryId": "1fd3e09b1e2f40888e419eb4d6d31a38" } }, "create-text": { "summary": "Creating a text setting definition", "value": { "dataType": "text", "name": "TextSettingName", "allowSystemSetting": true, "categoryId": "1fd3e09b1e2f40888e419eb4d6d31a38", "defaultValue": "Default Value", "regularExpression": ".*" } }, "create-xml": { "summary": "Creating an xml setting definition", "value": { "dataType": "xml", "name": "XmlSettingName", "allowSystemSetting": true, "categoryId": "1fd3e09b1e2f40888e419eb4d6d31a38", "defaultValue": "", "schema": null } } } } }, "required": true }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatedResourceId" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/shareddownloadlink/{sharedDownloadLinkId}": { "get": { "tags": [ "Shared download link" ], "summary": "Read a shared download link", "operationId": "getShareddownloadlinkBySharedDownloadLinkId", "parameters": [ { "name": "sharedDownloadLinkId", "in": "path", "description": "id of the shared download link", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SharedDownloadLinkResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/shareddownloadlinks": { "get": { "tags": [ "Shared download link" ], "summary": "Read a paged collection of shared download links", "description": "### Examples\n\nListing shared download links\n\nBy default the collection only contains the shared download links created by the current user. The parameters are specified as http headers.\n\n```http\nGET /shareddownloadlinks\naccept: application/hal+json\nfilter: expiresOn >= '2026-08-01'\nsort: createdon desc\npage: 1\npageSize: 25\n```\n\nListing shared download links of all users\n\nMembers of the Administrators user group can list the links of all users of the tenant by adding the allUsers query string parameter. For any other user this returns 403 Forbidden.\n\n```http\nGET /shareddownloadlinks?allUsers=true\naccept: application/hal+json\n```\n\nFiltering shared download links by file name\n\nThe collection can be filtered by link id, expiration date, revocation state, creator and file name, for example:\n\n```http\nGET /shareddownloadlinks?filter=File.FileName+%3D+'*brochure*'\naccept: application/hal+json\n```\n\nFiltering shared download links by revocation and expiration\n\nThe boolean revoked field matches links that have (or have not) been revoked; combine it with an expiration date predicate to select only active links:\n\n```http\nGET /shareddownloadlinks?filter=expiresOn+%3E%3D+'2026-08-01'+and+revoked+%3D+false\naccept: application/hal+json\n```", "operationId": "getShareddownloadlinks", "parameters": [ { "name": "allUsers", "in": "query", "description": "When true, returns links created by any user in the tenant. Requires the current user to be a member of the Administrators user group. Defaults to false: only links created by the current user are returned.", "schema": { "type": "boolean" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "A filter expression restricting which items are returned, e.g. \"ModifiedOn in today\". Omit to return all items the caller may see. The query parameter is the canonical location for this filter; the same value may alternatively be sent as a same-named request header.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "The property to sort by, optionally suffixed to control direction, e.g. \"createdOn\". Omit for the endpoint's default order. May also be sent as a same-named request header.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "1-based page number, used together with \"pageSize\". Defaults to the first page. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Number of items per page, used together with \"page\". Too high values will be capped. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of items to skip, used together with \"take\" as an alternative to \"page\"/\"pageSize\". May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "take", "in": "query", "description": "Number of items to return, used together with \"skip\" as an alternative to \"page\"/\"pageSize\". Too high values will be capped. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "title": "Shared download link paged collection resource", "type": "object", "properties": { "pageNumber": { "type": [ "null", "integer" ], "description": "The current page of this paged collection.", "format": "int32" }, "pageSize": { "type": [ "null", "integer" ], "description": "The current page size of this paged collection.", "format": "int32" }, "skip": { "type": [ "null", "integer" ], "description": "The current skip size of this paged collection.", "format": "int32" }, "take": { "type": [ "null", "integer" ], "description": "The current take size of this paged collection.", "format": "int32" }, "totalCount": { "type": "integer", "description": "The total count of items in this paged collection, not just on the current page.", "format": "int64" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/SharedDownloadLinkListItemResource" }, "description": "One page of this paged collection, which is a subcollection of the complete collection." } }, "description": "A paged collection of SharedDownloadLinkListItemResource items. The collection contains the shared download links created by the current user, or by all users of the tenant when requested by an administrator." } }, "application/hal+json": { "schema": { "required": [ "_links" ], "$ref": "#/components/schemas/SharedDownloadLinkPagedCollectionResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/shareddownloadlink/{sharedDownloadLinkId}/downloads": { "get": { "tags": [ "Shared download link" ], "summary": "Read a page of the download activity of a shared download link", "description": "Read a page of the download activity of a shared download link. Each entry is which file, which recipient, and when it was downloaded, newest first. Only the creator of the link or a member of the Administrators user group can view it. This is a dedicated, non-audit-trail read path; it does not expose (or modify) the existing compliance audit trail.", "operationId": "getShareddownloadlinkDownloadsBySharedDownloadLinkId", "parameters": [ { "name": "sharedDownloadLinkId", "in": "path", "description": "id of the shared download link", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "skip", "in": "query", "description": "Number of activity events to skip (paging).", "schema": { "type": "integer", "format": "int32" } }, { "name": "take", "in": "query", "description": "Number of activity events to return (paging).", "schema": { "type": "integer", "format": "int32" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SharedDownloadLinkDownloadCollectionResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/shareddownloadlinks/recipients/search": { "get": { "tags": [ "Shared download link" ], "summary": "Search distinct recipient email addresses across shared download links", "description": "Search distinct recipient email addresses across shared download links. Powers the Recipient filter's autocomplete suggestion list; this is a suggestion lookup, not the shared-links list filter itself.\n\n### Examples\n\nSearching distinct recipient email addresses\n\nPowers the Recipient filter's autocomplete suggestion list. By default only recipients of links created by the current user are searched; members of the Administrators user group can search recipients across all users' links by adding the allUsers query string parameter.\n\n```http\nGET /shareddownloadlinks/recipients/search?q=alice&skip=0&take=20\naccept: application/hal+json\n```\n\n```http\n200 OK\n{\n \"emails\": [\"alice@example.com\", \"alice.jones@example.com\"],\n \"totalCount\": 2\n}\n```", "operationId": "getShareddownloadlinksRecipientsSearch", "parameters": [ { "name": "q", "in": "query", "description": "Free text to match against recipient email (contains, case-insensitive).", "required": true, "schema": { "type": "string" } }, { "name": "allUsers", "in": "query", "description": "When true, searches recipients across every link in the tenant. Requires the current user to be a member of the Administrators user group. Defaults to false: only recipients of links created by the current user are searched.", "schema": { "type": "boolean" } }, { "name": "skip", "in": "query", "description": "Number of distinct emails to skip (paging).", "schema": { "type": "integer", "format": "int32" } }, { "name": "take", "in": "query", "description": "Number of distinct emails to return (paging).", "schema": { "type": "integer", "format": "int32" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SharedDownloadLinkRecipientSearchResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/shareddownloadlink/{sharedDownloadLinkId}/expiration": { "post": { "tags": [ "Shared download link" ], "summary": "Change the expiration date of a shared download link", "description": "Change the expiration date of a shared download link. Only the creator of the link or a member of the Administrators user group can change it. Setting a valid future date on an expired link whose resource is still retained reactivates it. Revoked links, and expired links whose resource has already been purged, cannot be changed.", "operationId": "createShareddownloadlinkExpirationBySharedDownloadLinkId", "parameters": [ { "name": "sharedDownloadLinkId", "in": "path", "description": "id of the shared download link", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditSharedDownloadLinkExpirationCommand" } } }, "required": true }, "responses": { "201": { "description": "Success" }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/shareddownloadlink/{sharedDownloadLinkId}/requestverificationcode": { "post": { "tags": [ "Shared download link" ], "summary": "Request a download verification token for a shared download link to be sent by email", "operationId": "createShareddownloadlinkRequestverificationcodeBySharedDownloadLinkId", "parameters": [ { "name": "sharedDownloadLinkId", "in": "path", "description": "id of the shared download link", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestVerificationTokenCommand" } } }, "required": true }, "responses": { "201": { "description": "Success" }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/shareddownloadlink/{sharedDownloadLinkId}/revoke": { "post": { "tags": [ "Shared download link" ], "summary": "Revoke a shared download link", "description": "Revoke a shared download link. Only the creator of the link or a member of the Administrators user group can revoke. A revoked link no longer grants downloads, its underlying resource is deleted immediately, and it cannot be reactivated.", "operationId": "createShareddownloadlinkRevokeBySharedDownloadLinkId", "parameters": [ { "name": "sharedDownloadLinkId", "in": "path", "description": "id of the shared download link", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Success" }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/shareddownloadlink/{sharedDownloadLinkId}/files/{fileId}": { "get": { "tags": [ "Shared download link" ], "summary": "Get the download uri for a shared download link file", "operationId": "getShareddownloadlinkFilesBySharedDownloadLinkIdAndFileId", "parameters": [ { "name": "sharedDownloadLinkId", "in": "path", "description": "id of the shared download link", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "fileId", "in": "path", "description": "id of the file attached to the shared download link", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "email", "in": "query", "description": "Optional email of the user for verification flow. Only required when the link is configured to have one.", "schema": { "type": "string" } }, { "name": "verificationCode", "in": "query", "description": "Optional verification code. Only required when the link is configured to have one.", "schema": { "type": "string" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SharedDownloadLinkFileDownloadUriResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/subscription/{objectId}": { "get": { "tags": [ "Subscription" ], "summary": "Read a subscription", "operationId": "getSubscriptionByObjectId", "parameters": [ { "name": "objectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "delete": { "tags": [ "Subscription" ], "summary": "Delete all subscriptions for a record", "operationId": "deleteSubscriptionByObjectId", "parameters": [ { "name": "objectId", "in": "path", "description": "The subscribed record id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/subscription": { "get": { "tags": [ "Subscription" ], "summary": "Read a subscription by its objectId, userId and type", "operationId": "getSubscription", "parameters": [ { "name": "objectId", "in": "query", "description": "subscribed record", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "userId", "in": "query", "description": "Subscribed user", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "subscriptionType", "in": "query", "description": "Type of subscription", "required": true, "schema": { "enum": [ "Follow", "Expiry" ], "type": "string" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/subscriptions": { "get": { "tags": [ "Subscription" ], "summary": "Read the subscribed users", "operationId": "getSubscriptions", "parameters": [ { "name": "objectId", "in": "query", "description": "subscribed record", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "subscriptionType", "in": "query", "description": "Type of subscription", "required": true, "schema": { "enum": [ "Follow", "Expiry" ], "type": "string" } }, { "name": "objectType", "in": "query", "description": "Type of object", "required": true, "schema": { "enum": [ "Record", "Collection" ], "type": "string" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "post": { "tags": [ "Subscription" ], "summary": "Create a new subscription", "operationId": "createSubscriptions", "parameters": [ { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionCreateCommand" } } }, "required": true }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatedResourceId" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/supportedversions/{version}": { "get": { "tags": [ "Supported version" ], "summary": "Read the details of a single supported version", "operationId": "getSupportedversionsByVersion", "parameters": [ { "name": "version", "in": "path", "description": "version of the API", "required": true, "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VersionResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/supportedversions": { "get": { "tags": [ "Supported version" ], "summary": "Read all supported versions of the API", "operationId": "getSupportedversions", "parameters": [ { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "$ref": "#/components/mediaTypes/VersionCollectionResourceJson" }, "application/hal+json": { "$ref": "#/components/mediaTypes/VersionCollectionResourceHal" } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/translation/{translationId}": { "get": { "tags": [ "Translation" ], "summary": "Read a translation", "description": "### Examples\n\nReading a translation\n\nIf the translation was not found, the API call will fail with a **404 Not found** HTTP status code.\n\n```http\nGET /translation/e5a5f7bb73924bfb9fa0a8b100af8e6f\n```", "operationId": "getTranslationByTranslationId", "parameters": [ { "name": "translationId", "in": "path", "description": "id of the translation", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TranslationResource" }, "example": { "id": "e5a5f7bb73924bfb9fa0a8b100af8e6f", "studio": "studio name", "module": "module name", "name": "element name", "tag": null, "localizedValues": [ { "languageId": "c2bd4f9bbb954bcb80c31e924c9c26dc", "value": "translation value" } ], "modifiedOn": "2018-03-28T10:39:10.933Z", "createdOn": "2018-03-28T10:39:10.873Z" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "put": { "tags": [ "Translation" ], "summary": "Edit an existing translation", "operationId": "updateTranslationByTranslationId", "parameters": [ { "name": "translationId", "in": "path", "description": "id of the translation", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TranslationEditCommand" }, "example": { "studio": "studio name", "module": "module name", "name": "element name", "tag": "some tag", "localizedValues": [ { "languageId": "c2bd4f9bbb954bcb80c31e924c9c26dc", "value": "new translation value" } ] } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "delete": { "tags": [ "Translation" ], "summary": "Delete the specified translation", "description": "### Examples\n\nDeleting a translation\n\n```http\nDELETE /translation/e5a5f7bb73924bfb9fa0a8b100af8e6f\n```", "operationId": "deleteTranslationByTranslationId", "parameters": [ { "name": "translationId", "in": "path", "description": "id of the translation", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/translation": { "get": { "tags": [ "Translation" ], "summary": "Read a translation by its key", "description": "### Examples\n\nReading a translation using a key\n\nIf the translation was not found, the API call will fail with a **404 Not found** HTTP status code.\n\n```http\nGET /translation?studio={studioName}&module={moduleName}&name={elementName}\n```", "operationId": "getTranslation", "parameters": [ { "name": "studio", "in": "query", "description": "studio name for the translation", "required": true, "schema": { "type": "string" } }, { "name": "module", "in": "query", "description": "module name for the translation", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "name of the element that should be translated", "required": true, "schema": { "type": "string" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TranslationResource" }, "example": { "id": "e5a5f7bb73924bfb9fa0a8b100af8e6f", "studio": "studio name", "module": "module name", "name": "element name", "tag": null, "localizedValues": [ { "languageId": "c2bd4f9bbb954bcb80c31e924c9c26dc", "value": "translation value" } ], "modifiedOn": "2018-03-28T10:39:10.933Z", "createdOn": "2018-03-28T10:39:10.873Z" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/translations": { "get": { "tags": [ "Translation" ], "summary": "Read all translations", "description": "### Examples\n\nSearching for translations (HTTP headers)\n\n```http\nGET /translations\naccept: application/hal+json\nfilter: ModifiedOn in today\nsort: createdon\npage: 1\npageSize: 20\n```\n\nSearching for translations (query string parameters)\n\n```http\nGET /translations?filter=ModifiedOn+in+today&sort=createdon&page=1&pagesize=10\n```\n\nSearching for translations (headers + query string combined)\n\n```http\nGET /translations?page=1&pagesize=10\nfilter: ModifiedOn in today\nsort: createdon\n```", "operationId": "getTranslations", "parameters": [ { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "A filter expression restricting which items are returned, e.g. \"ModifiedOn in today\". Omit to return all items the caller may see. The query parameter is the canonical location for this filter; the same value may alternatively be sent as a same-named request header.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "The property to sort by, optionally suffixed to control direction, e.g. \"createdOn\". Omit for the endpoint's default order. May also be sent as a same-named request header.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "1-based page number, used together with \"pageSize\". Defaults to the first page. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Number of items per page, used together with \"page\". Too high values will be capped. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of items to skip, used together with \"take\" as an alternative to \"page\"/\"pageSize\". May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "take", "in": "query", "description": "Number of items to return, used together with \"skip\" as an alternative to \"page\"/\"pageSize\". Too high values will be capped. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/TranslationResource" } }, "page": { "type": [ "null", "integer" ] }, "pageSize": { "type": [ "null", "integer" ] }, "totalCount": { "type": "integer", "format": "int64" } }, "description": "A paged/collection response envelope." } }, "application/hal+json": { "schema": { "required": [ "_links" ], "type": "object", "properties": { "_links": { "type": "object", "properties": { "self": { "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/TranslationResource" } }, "page": { "type": [ "null", "integer" ] }, "pageSize": { "type": [ "null", "integer" ] }, "totalCount": { "type": "integer", "format": "int64" } }, "description": "A paged/collection response envelope." } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "post": { "tags": [ "Translation" ], "summary": "Create a new translation", "operationId": "createTranslations", "parameters": [ { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TranslationCreateCommand" }, "example": { "studio": "studio name", "module": "module name", "name": "element name", "tag": "some tag", "localizedValues": [ { "languageId": "c2bd4f9b-bb95-4bcb-80c3-1e924c9c26dc", "value": "translation value" } ] } } }, "required": true }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatedResourceId" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/uniquekeyindex": { "get": { "tags": [ "Unique key index" ], "summary": "Read the unique key index status", "operationId": "getUniquekeyindex", "parameters": [ { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UniqueKeyIndexResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "put": { "tags": [ "Unique key index" ], "summary": "Trigger a rebuild of the unique key index", "operationId": "updateUniquekeyindex", "parameters": [ { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateUniqueKeyIndexCommand" } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/user/{userId}": { "get": { "tags": [ "User" ], "summary": "Read a user", "operationId": "getUserByUserId", "parameters": [ { "name": "userId", "in": "path", "description": "id of the user", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/users": { "get": { "tags": [ "User" ], "summary": "Read a collection of users", "operationId": "getUsers", "parameters": [ { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "A filter expression restricting which items are returned, e.g. \"ModifiedOn in today\". Omit to return all items the caller may see. The query parameter is the canonical location for this filter; the same value may alternatively be sent as a same-named request header.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "The property to sort by, optionally suffixed to control direction, e.g. \"createdOn\". Omit for the endpoint's default order. May also be sent as a same-named request header.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "1-based page number, used together with \"pageSize\". Defaults to the first page. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Number of items per page, used together with \"page\". Too high values will be capped. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of items to skip, used together with \"take\" as an alternative to \"page\"/\"pageSize\". May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "take", "in": "query", "description": "Number of items to return, used together with \"skip\" as an alternative to \"page\"/\"pageSize\". Too high values will be capped. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "$ref": "#/components/mediaTypes/UserPagedCollectionResourceJson" }, "application/hal+json": { "$ref": "#/components/mediaTypes/UserPagedCollectionResourceHal" } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/user/{userId}/fields": { "get": { "tags": [ "User" ], "summary": "Read all fields of a user", "operationId": "getUserFieldsByUserId", "parameters": [ { "name": "userId", "in": "path", "description": "id of the user", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "1-based page number, used together with \"pageSize\". Defaults to the first page. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Number of items per page, used together with \"page\". Too high values will be capped. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of items to skip, used together with \"take\" as an alternative to \"page\"/\"pageSize\". May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "take", "in": "query", "description": "Number of items to return, used together with \"skip\" as an alternative to \"page\"/\"pageSize\". Too high values will be capped. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "$ref": "#/components/mediaTypes/FieldCollectionResourceJson" }, "application/hal+json": { "$ref": "#/components/mediaTypes/FieldCollectionResourceHal" } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/user/{userId}/image": { "get": { "tags": [ "User" ], "summary": "Read the picture of this user", "operationId": "getUserImageByUserId", "parameters": [ { "name": "userId", "in": "path", "description": "id of the user", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImageResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/user/{userId}/memberships": { "get": { "tags": [ "User" ], "summary": "Read all user group memberships of a user", "operationId": "getUserMembershipsByUserId", "parameters": [ { "name": "userId", "in": "path", "description": "id of the user", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "1-based page number, used together with \"pageSize\". Defaults to the first page. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Number of items per page, used together with \"page\". Too high values will be capped. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of items to skip, used together with \"take\" as an alternative to \"page\"/\"pageSize\". May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "take", "in": "query", "description": "Number of items to return, used together with \"skip\" as an alternative to \"page\"/\"pageSize\". Too high values will be capped. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserGroupCollectionResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/user/{userId}/permissions": { "get": { "tags": [ "User" ], "summary": "Read all permissions of a user", "operationId": "getUserPermissionsByUserId", "parameters": [ { "name": "userId", "in": "path", "description": "id of the user", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "1-based page number, used together with \"pageSize\". Defaults to the first page. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Number of items per page, used together with \"page\". Too high values will be capped. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of items to skip, used together with \"take\" as an alternative to \"page\"/\"pageSize\". May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "take", "in": "query", "description": "Number of items to return, used together with \"skip\" as an alternative to \"page\"/\"pageSize\". Too high values will be capped. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "$ref": "#/components/mediaTypes/PermissionValueCollectionResourceJson" }, "application/hal+json": { "$ref": "#/components/mediaTypes/PermissionValueCollectionResourceHal" } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "put": { "tags": [ "User" ], "summary": "Edit an existing user's permissions", "operationId": "updateUserPermissionsByUserId", "parameters": [ { "name": "userId", "in": "path", "description": "id of the user", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserPermissionEditCommand" }, "example": { "permissions": { "addOrUpdate": [ { "name": "RoleMyPermission", "value": "granted" }, { "name": "AnotherPermission", "value": "denied" } ] } } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/user/{userId}/field/{fieldId}": { "get": { "tags": [ "User" ], "summary": "Read a field of a user", "operationId": "getUserFieldByUserIdAndFieldId", "parameters": [ { "name": "userId", "in": "path", "description": "id of the user", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "fieldId", "in": "path", "description": "id of the field", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/SingleLineTextFieldResource" }, { "$ref": "#/components/schemas/MultiLineTextFieldResource" }, { "$ref": "#/components/schemas/NumericFieldResource" }, { "$ref": "#/components/schemas/DateTimeFieldResource" }, { "$ref": "#/components/schemas/DateFieldResource" }, { "$ref": "#/components/schemas/TimeFieldResource" }, { "$ref": "#/components/schemas/OptionListFieldResource" }, { "$ref": "#/components/schemas/DurationFieldResource" }, { "$ref": "#/components/schemas/UserListFieldResource" }, { "$ref": "#/components/schemas/UserGroupListFieldResource" }, { "$ref": "#/components/schemas/HtmlFieldResource" }, { "$ref": "#/components/schemas/JsonFieldResource" }, { "$ref": "#/components/schemas/ClassificationListFieldResource" }, { "$ref": "#/components/schemas/RecordListFieldResource" }, { "$ref": "#/components/schemas/RecordLinkFieldResource" }, { "$ref": "#/components/schemas/LanguageListFieldResource" }, { "$ref": "#/components/schemas/TextListFieldResource" }, { "$ref": "#/components/schemas/HyperlinkListFieldResource" } ], "discriminator": { "propertyName": "dataType", "mapping": { "SingleLineText": "#/components/schemas/SingleLineTextFieldResource", "MultiLineText": "#/components/schemas/MultiLineTextFieldResource", "Numeric": "#/components/schemas/NumericFieldResource", "DateTime": "#/components/schemas/DateTimeFieldResource", "Date": "#/components/schemas/DateFieldResource", "Time": "#/components/schemas/TimeFieldResource", "OptionList": "#/components/schemas/OptionListFieldResource", "Duration": "#/components/schemas/DurationFieldResource", "UserList": "#/components/schemas/UserListFieldResource", "UserGroupList": "#/components/schemas/UserGroupListFieldResource", "Html": "#/components/schemas/HtmlFieldResource", "Json": "#/components/schemas/JsonFieldResource", "ClassificationList": "#/components/schemas/ClassificationListFieldResource", "RecordList": "#/components/schemas/RecordListFieldResource", "RecordLink": "#/components/schemas/RecordLinkFieldResource", "LanguageList": "#/components/schemas/LanguageListFieldResource", "TextList": "#/components/schemas/TextListFieldResource", "HyperlinkList": "#/components/schemas/HyperlinkListFieldResource" } } } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/usergroup/{userGroupId}": { "get": { "tags": [ "User group" ], "summary": "Read a user group", "operationId": "getUsergroupByUserGroupId", "parameters": [ { "name": "userGroupId", "in": "path", "description": "id of the user group", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserGroupResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/usergroups": { "get": { "tags": [ "User group" ], "summary": "Read all user groups", "operationId": "getUsergroups", "parameters": [ { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "A filter expression restricting which items are returned, e.g. \"ModifiedOn in today\". Omit to return all items the caller may see. The query parameter is the canonical location for this filter; the same value may alternatively be sent as a same-named request header.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "The property to sort by, optionally suffixed to control direction, e.g. \"createdOn\". Omit for the endpoint's default order. May also be sent as a same-named request header.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "1-based page number, used together with \"pageSize\". Defaults to the first page. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Number of items per page, used together with \"page\". Too high values will be capped. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of items to skip, used together with \"take\" as an alternative to \"page\"/\"pageSize\". May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "take", "in": "query", "description": "Number of items to return, used together with \"skip\" as an alternative to \"page\"/\"pageSize\". Too high values will be capped. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "$ref": "#/components/mediaTypes/IPagedCollectionResourceOfUserGroupResourceJson" }, "application/hal+json": { "$ref": "#/components/mediaTypes/IPagedCollectionResourceOfUserGroupResourceHal" } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/usergroups/permissions": { "put": { "tags": [ "User group" ], "summary": "Edit permissions for multiple user groups in a single operation", "operationId": "updateUsergroupsPermissions", "parameters": [ { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserGroupPermissionBatchEditCommand" } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/usergroup/{userGroupId}/permissions": { "get": { "tags": [ "User group" ], "summary": "Read all permissions of a user group", "description": "### Examples\n\nSearching for the permissions of a user group\n\nSearching for the permissions of a user\n\n```http\nGET /usergroup/c590b5d487d54b878619a7fc00cce3e6/permissions\n```\n\n```http\nGET /user/51e0305b2074470880a7a80b00dbe930/permissions\n```", "operationId": "getUsergroupPermissionsByUserGroupId", "parameters": [ { "name": "userGroupId", "in": "path", "description": "id of the user group", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "A filter expression restricting which items are returned, e.g. \"ModifiedOn in today\". Omit to return all items the caller may see. The query parameter is the canonical location for this filter; the same value may alternatively be sent as a same-named request header.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "1-based page number, used together with \"pageSize\". Defaults to the first page. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Number of items per page, used together with \"page\". Too high values will be capped. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of items to skip, used together with \"take\" as an alternative to \"page\"/\"pageSize\". May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "take", "in": "query", "description": "Number of items to return, used together with \"skip\" as an alternative to \"page\"/\"pageSize\". Too high values will be capped. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "title": "Permission value collection resource", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PermissionValueResource" }, "description": "A collection of resource items." } }, "description": "Representation of a non-paged collection of permission values" } }, "application/hal+json": { "schema": { "required": [ "_links" ], "$ref": "#/components/schemas/PermissionValueCollectionResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "put": { "tags": [ "User group" ], "summary": "Edit an existing user group's permissions", "operationId": "updateUsergroupPermissionsByUserGroupId", "parameters": [ { "name": "userGroupId", "in": "path", "description": "id of the user group", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserGroupPermissionEditCommand" }, "example": { "permissions": { "addOrUpdate": [ { "name": "RoleMyPermission", "value": "granted" }, { "name": "AnotherPermission", "value": "denied" } ] } } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/watermark/{watermarkId}": { "get": { "tags": [ "Watermark" ], "summary": "Read a watermark", "operationId": "getWatermarkByWatermarkId", "parameters": [ { "name": "watermarkId", "in": "path", "description": "id of the watermark", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WatermarkResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "put": { "tags": [ "Watermark" ], "summary": "Edit an existing watermark", "operationId": "updateWatermarkByWatermarkId", "parameters": [ { "name": "watermarkId", "in": "path", "description": "id of the watermark", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WatermarkEditCommand" }, "example": { "name": "Watermark", "position": "MiddleCenter", "tag": "", "image": "OWY4OGNhNGYwZTE4NGE5YTkyYWNhODA5MDA5NGQwNTU=" } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "delete": { "tags": [ "Watermark" ], "summary": "Delete the specified watermark", "description": "### Examples\n\nDeleting a watermark\n\n```http\nDELETE /watermark/c584888369ab4f049f367ea9f19137e3\n```\n\nApplying a watermark\n\nConfigured through the creation of a record (POST /records) and/or editing of a record (PUT /record/{recordId}). The \"**watermarkType**\" parameter specifies which watermark will be used (if any) and the \"**watermarkId**\" parameter specifies the ID of the manually specified watermark if the \"watermarkType\" parameter is set to \"UseSpecified\". The possible combinations of these parameters in a request are:\n\nNote: The \"watermarkId\" parameter will be validated in \"UseSpecified\" case only. In all the other cases \"watermarkId\" parameter can still be set but will just be used as a data storage.", "operationId": "deleteWatermarkByWatermarkId", "parameters": [ { "name": "watermarkId", "in": "path", "description": "id of the watermark", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/watermarks": { "get": { "tags": [ "Watermark" ], "summary": "Read all watermarks", "description": "### Examples\n\nSearching for watermarks (HTTP headers)\n\n```http\nGET /watermarks\naccept: application/hal+json\nfilter: ModifiedOn in today\nsort: createdon\npage: 1\npageSize: 20\n```\n\nSearching for watermarks (query string parameters)\n\n```http\nGET /watermarks?filter=ModifiedOn+in+today&sort=createdon&page=1&pagesize=10\n```\n\nSearching for watermarks (headers + query string combined)\n\n```http\nGET /watermarks?page=1&pagesize=10\nfilter: ModifiedOn in today\nsort: createdon\n```", "operationId": "getWatermarks", "parameters": [ { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "A filter expression restricting which items are returned, e.g. \"ModifiedOn in today\". Omit to return all items the caller may see. The query parameter is the canonical location for this filter; the same value may alternatively be sent as a same-named request header.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "The property to sort by, optionally suffixed to control direction, e.g. \"createdOn\". Omit for the endpoint's default order. May also be sent as a same-named request header.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "1-based page number, used together with \"pageSize\". Defaults to the first page. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Number of items per page, used together with \"page\". Too high values will be capped. Ignored when \"skip\"/\"take\" are supplied instead. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of items to skip, used together with \"take\" as an alternative to \"page\"/\"pageSize\". May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } }, { "name": "take", "in": "query", "description": "Number of items to return, used together with \"skip\" as an alternative to \"page\"/\"pageSize\". Too high values will be capped. May also be sent as a same-named request header.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/WatermarkResource" } }, "page": { "type": [ "null", "integer" ] }, "pageSize": { "type": [ "null", "integer" ] }, "totalCount": { "type": "integer", "format": "int64" } }, "description": "A paged/collection response envelope." } }, "application/hal+json": { "schema": { "required": [ "_links" ], "type": "object", "properties": { "_links": { "type": "object", "properties": { "self": { "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/WatermarkResource" } }, "page": { "type": [ "null", "integer" ] }, "pageSize": { "type": [ "null", "integer" ] }, "totalCount": { "type": "integer", "format": "int64" } }, "description": "A paged/collection response envelope." } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } }, "post": { "tags": [ "Watermark" ], "summary": "Create a new watermark", "description": "Create a new watermark. In order to successfully create a watermark, the name, position, mediaEngines, image must be specified via the name, position, mediaEngines and image properties.", "operationId": "createWatermarks", "parameters": [ { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WatermarkCreateCommand" }, "example": { "name": "Test watermark", "position": "MiddleCenter", "tag": "", "image": "NjlmMjFlOGQ0Mjg3NGEyN2EyMDJhODFjMDBlNjRkZTU=" } } }, "required": true }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatedResourceId" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } }, "/watermark/{watermarkId}/image": { "get": { "tags": [ "Watermark" ], "summary": "Read the image of a watermark", "operationId": "getWatermarkImageByWatermarkId", "parameters": [ { "name": "watermarkId", "in": "path", "description": "id of the watermark", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "API-VERSION", "in": "header", "description": "The REST API version to target, e.g. \"1\".", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "Accept", "in": "header", "description": "The desired response media type. If omitted, the server defaults to \"application/hal+json\", which includes \"_links\"/\"_embedded\" hypermedia so a client can navigate to related resources without constructing URLs itself. For most integrations, requesting \"application/json\" instead is simpler and produces a smaller, flatter response - recommended unless you need that hypermedia.", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "The bearer token used to authenticate the request.", "required": true, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "Identifies the calling application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImageResource" } } } }, "400": { "description": "The request was malformed or failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "401": { "description": "Authentication is required." }, "403": { "description": "The caller is not authorized to perform this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } }, "404": { "description": "The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorContent" } } } } } } } }, "components": { "schemas": { "AIExtractionOptions": { "title": "AI extraction options", "enum": [ "None", "SmartTags", "Faces", "CustomSmartTags", "Text", "Transcripts" ], "type": "string", "x-enum-descriptions": [ "No extraction", "Extract smart tags", "Extract faces", "Extract custom smart tags", "Extract text", "Extract transcripts" ] }, "AIInfluenced": { "title": "AI influenced", "enum": [ "Unknown", "No", "Yes" ], "type": "string", "x-enum-descriptions": [ "It is not known whether AI was involved.", "AI was not involved.", "AI was involved." ] }, "AcceptDownloadOrderAgreementJobCommand": { "title": "Accept download order agreement job command", "type": "object", "properties": { "creatorEmail": { "type": "string", "description": "Email address of the user the job is created on behalf of." }, "disableNotification": { "type": "boolean", "description": "When set to true, suppresses notifications for this job." }, "earliestStartDate": { "type": [ "null", "string" ], "description": "Earliest date and time at which the job is allowed to start executing.", "format": "date-time" }, "priority": { "enum": [ "High", "Medium" ], "type": "string", "description": "Priority used to schedule this job relative to other maintenance jobs." }, "type": { "enum": [ "Classification", "Record", "ExportAuditTrail", "BulkRecord", "AcceptDownloadOrderAgreement", "BulkCollection", "ExportContentItemsList" ], "type": "string", "description": "Type of maintenance job to create." }, "targets": { "type": "array", "items": { "$ref": "#/components/schemas/AcceptDownloadOrderAgreementJobCommandTargetModel" }, "description": "Targets the job's actions are applied to." }, "actions": { "type": "array", "items": { "$ref": "#/components/schemas/ActionModel" }, "description": "Actions to execute for each target of this job." }, "title": { "type": "string", "description": "Title of the job. For a download or contact-sheet order this is shown on the Downloads page in Content Workspace; if omitted, it defaults to the file name, or \"X items\" when multiple files were ordered. Either plain text, or a JSON string of the form {\"studioName\":\"...\",\"moduleName\":\"...\",\"translationKey\":\"...\"} to look up a translated value for non-English users (see the Localization > Translations section of the DAM Administrator Guide for how translations are registered)." }, "description": { "type": "string", "description": "Description of the job. For a download or contact-sheet order this is shown on the Downloads page in Content Workspace; if omitted, it defaults to \"Download\". Accepts the same plain-text-or-translation-key JSON format as Title." }, "errorMode": { "type": "string", "description": "Determines how the job behaves when one of its targets fails to execute." } }, "description": "Creates a maintenance job that records acceptance of a download order agreement." }, "AcceptDownloadOrderAgreementJobCommandTargetModel": { "title": "Accept download order agreement job command target model", "type": "object", "properties": { "orderId": { "type": "string", "description": "Id of the download order the agreement acceptance applies to.", "format": "uuid" }, "userId": { "type": "string", "description": "Id of the user who accepted the agreement.", "format": "uuid" }, "acceptanceDate": { "type": "string", "description": "Date and time the agreement was accepted.", "format": "date-time" }, "downloadAgreementContentId": { "type": "integer", "description": "Id of the content record for the download agreement that was accepted.", "format": "int32" }, "forceRetry": { "type": "boolean", "description": "When set to true, forces this target to be retried even if it previously failed." }, "tag": { "type": "string", "description": "Free-form tag that can be used to identify or group this target." } }, "description": "Target for an accept download order agreement maintenance job." }, "AccessListCollectionModel": { "title": "Access list collection model", "type": "object", "properties": { "addOrUpdate": { "type": "array", "items": { "$ref": "#/components/schemas/AccessListIdentificationModel" }, "description": "Access lists to add or update." }, "remove": { "type": "array", "items": { "$ref": "#/components/schemas/AccessListIdentificationModel" }, "description": "Access lists to remove." } }, "description": "Collection of access lists to add, update, or remove." }, "AccessListCreateCommand": { "title": "Access list create command", "type": "object", "properties": { "externalId": { "type": "string", "description": "External identifier for this access list." }, "type": { "type": "string", "description": "Type of the access list." }, "permission": { "enum": [ "Read", "Modify", "Delete", "FullControl" ], "type": [ "null", "string" ], "description": "Permission level granted by this access list." }, "users": { "description": "Users to add or remove from this access list.", "$ref": "#/components/schemas/EditableIdCollectionModel" }, "userGroups": { "description": "User groups to add or remove from this access list.", "$ref": "#/components/schemas/EditableIdCollectionModel" } }, "description": "Creates a new access list." }, "AccessListEditByIdCommand": { "title": "Access list edit by id command", "type": "object", "properties": { "users": { "description": "Users to add or remove from this access list.", "$ref": "#/components/schemas/EditableIdCollectionModel" }, "userGroups": { "description": "User groups to add or remove from this access list.", "$ref": "#/components/schemas/EditableIdCollectionModel" } }, "description": "Updates an existing access list identified by its ID." }, "AccessListEditByUniqueParamsCommand": { "title": "Access list edit by unique params command", "type": "object", "properties": { "externalId": { "type": "string", "description": "External identifier of the access list to update." }, "permission": { "enum": [ "Read", "Modify", "Delete", "FullControl" ], "type": [ "null", "string" ], "description": "Permission level of the access list to update." }, "type": { "type": "string", "description": "Type of the access list to update." }, "users": { "description": "Users to add or remove from this access list.", "$ref": "#/components/schemas/EditableIdCollectionModel" }, "userGroups": { "description": "User groups to add or remove from this access list.", "$ref": "#/components/schemas/EditableIdCollectionModel" } }, "description": "Updates an existing access list identified by its external ID, type, and permission." }, "AccessListIdentificationModel": { "title": "Access list identification model", "type": "object", "properties": { "id": { "type": "string", "description": "Identifier of the access list.", "format": "uuid" }, "externalId": { "type": "string", "description": "External identifier of the access list." }, "type": { "type": "string", "description": "Type of the access list." }, "permission": { "type": "integer", "description": "Permission level of the access list.", "format": "int32" } }, "description": "Identifies an access list either by ID or by external ID, type, and permission." }, "AccessListPagedCollectionResource": { "title": "Access list paged collection resource", "type": "object", "properties": { "pageNumber": { "type": [ "null", "integer" ], "description": "The current page of this paged collection.", "format": "int32" }, "pageSize": { "type": [ "null", "integer" ], "description": "The current page size of this paged collection.", "format": "int32" }, "skip": { "type": [ "null", "integer" ], "description": "The current skip size of this paged collection.", "format": "int32" }, "take": { "type": [ "null", "integer" ], "description": "The current take size of this paged collection.", "format": "int32" }, "totalCount": { "type": "integer", "description": "The total count of items in this paged collection, not just on the current page.", "format": "int64" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/AccessListResource" }, "description": "One page of this paged collection, which is a subcollection of the complete collection." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" }, "first": { "description": "A link to the first page of this paged collection.", "$ref": "#/components/schemas/Link" }, "prev": { "description": "A link to the previous page of this paged collection.", "$ref": "#/components/schemas/Link" }, "next": { "description": "A link to the next page of this paged collection.", "$ref": "#/components/schemas/Link" }, "last": { "description": "A link to the last page of this paged collection.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of a paged collection of access lists" }, "AccessListResource": { "title": "Access list resource", "type": "object", "properties": { "id": { "type": "string", "description": "The Id of this accessList.", "format": "uuid" }, "externalId": { "type": "string", "description": "The ExternalId of this accessList." }, "type": { "type": "string", "description": "The Type of this accessList." }, "permission": { "type": "integer", "description": "The permission of this accessList.", "format": "int32" }, "tag": { "type": "string", "description": "The tag of this accessList." }, "users": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "The ids of the users linked to this accessList." }, "userGroups": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "The ids of the user groups linked to this access list." }, "modifiedOn": { "type": "string", "description": "Last modification datetime in UTC time.", "format": "date-time" }, "createdOn": { "type": "string", "description": "Creation datetime in UTC time.", "format": "date-time" }, "_links": { "type": "object", "properties": { "modifiedBy": { "description": "Relation to the user who last modified this access list.", "$ref": "#/components/schemas/Link" }, "createdBy": { "description": "Relation to the user who created this access list.", "$ref": "#/components/schemas/Link" }, "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "modifiedBy": { "description": "Relation to the user who last modified this access list. Embed via a \"select-accesslist: modifiedBy\" header.", "$ref": "#/components/schemas/UserResource" }, "createdBy": { "description": "Relation to the user who created this access list. Embed via a \"select-accesslist: createdBy\" header.", "$ref": "#/components/schemas/UserResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "A reusable, named set of users and user groups with permission grants (record, classification, download, etc.) that can be assigned to classifications or records in bulk, instead of granting each permission individually." }, "ActionModel": { "title": "Action model", "type": "object", "properties": { "action": { "description": "Action to execute.", "$ref": "#/components/schemas/MaintenanceJobAction" }, "parameters": { "anyOf": [ { "$ref": "#/components/schemas/OverwriteFieldActionParametersModel" }, { "$ref": "#/components/schemas/AppendTextFieldActionParametersModel" }, { "$ref": "#/components/schemas/ReplaceTextFieldActionParametersModel" }, { "$ref": "#/components/schemas/ClassificationCopyActionParametersModel" }, { "$ref": "#/components/schemas/ClassificationMoveActionParametersModel" }, { "$ref": "#/components/schemas/ClassifyRecordActionParametersModel" }, { "$ref": "#/components/schemas/UnclassifyRecordActionParametersModel" }, { "$ref": "#/components/schemas/DeleteActionParametersModel" }, { "$ref": "#/components/schemas/RefreshFileRecordActionParametersModel" }, { "$ref": "#/components/schemas/ChangeContentTypeActionParametersModel" }, { "$ref": "#/components/schemas/TrimVideoActionParametersModel" }, { "$ref": "#/components/schemas/CropImageActionParametersModel" }, { "$ref": "#/components/schemas/CreatePresetCropsActionParametersModel" }, { "$ref": "#/components/schemas/AprimoAIActionParametersModel" }, { "$ref": "#/components/schemas/RefreshOnAkamaiCdnActionParametersModel" }, { "$ref": "#/components/schemas/RefreshOnPublicCdnActionParametersModel" }, { "$ref": "#/components/schemas/CreateReviewFileActionParametersModel" }, { "$ref": "#/components/schemas/AppendToFieldActionParametersModel" }, { "$ref": "#/components/schemas/RemoveFromFieldActionParametersModel" }, { "$ref": "#/components/schemas/CreateRenditionsActionParametersModel" }, { "$ref": "#/components/schemas/ChangeRecordStatusActionParametersModel" }, { "$ref": "#/components/schemas/CreatePublicLinksActionParametersModel" }, { "$ref": "#/components/schemas/DeletePublicLinksActionParametersModel" }, { "$ref": "#/components/schemas/RefreshUrlToPdfActionParametersModel" }, { "$ref": "#/components/schemas/PredictiveMetadataActionParametersModel" }, { "$ref": "#/components/schemas/EnhancedCaptioningActionParametersModel" }, { "$ref": "#/components/schemas/TranslateSubtitleActionParametersModel" }, { "$ref": "#/components/schemas/ResolveContentTypeActionParametersModel" }, { "$ref": "#/components/schemas/ChangeCollectionOwnerActionParametersModel" }, { "$ref": "#/components/schemas/RunReviewAgentActionParametersModel" }, { "$ref": "#/components/schemas/ChangeCollectionStatusActionParametersModel" } ], "description": "Key/value parameters for this action. Which keys are valid, and what their values mean, depends entirely on which \"action\" this is paired with - there is no single fixed shape." } }, "description": "Action to execute for each target of a maintenance job, together with its parameters." }, "ActionTypeCollectionResource": { "title": "Action type collection resource", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ActionTypeResource" }, "description": "A collection of non-resource items." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of a collection of Action Types" }, "ActionTypeResource": { "title": "Action type resource", "type": "object", "properties": { "id": { "type": "string", "description": "Identifier for this action type.", "format": "uuid" }, "name": { "type": "string", "description": "Name of this action type." } }, "description": "The kind of automated check a check performs against a file version (e.g. a virus scan or an image validation) - every check is configured with one action type." }, "AdditionalFileCollectionResource": { "title": "Additional file collection resource", "type": "object", "properties": { "items": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/CropResource" }, { "$ref": "#/components/schemas/TrimResource" }, { "$ref": "#/components/schemas/StillResource" }, { "$ref": "#/components/schemas/SpinsetResource" }, { "$ref": "#/components/schemas/ThreeDimensionalFileResource" }, { "$ref": "#/components/schemas/SubtitleResource" }, { "$ref": "#/components/schemas/ExternalFileResource" }, { "$ref": "#/components/schemas/CustomFileResource" }, { "$ref": "#/components/schemas/VideoPersonThumbnailResource" }, { "$ref": "#/components/schemas/AdditionalFileResource" } ] }, "description": "A collection of resource items." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of a non-paged collection of additional files" }, "AdditionalFileModel": { "title": "Additional file model", "type": "object", "properties": { "id": { "type": "string", "description": "Identifier of the additional file. When adding a new additional file, pass the upload token returned after uploading the file; when editing an existing additional file, pass its GUID." }, "label": { "type": "string", "description": "Display label of the additional file." }, "tag": { "type": "string", "description": "Tag used to distinguish or categorize this additional file." }, "usages": { "type": "array", "items": { "type": "string" }, "description": "Usages this additional file applies to." }, "purposes": { "type": "array", "items": { "type": "string" }, "description": "Purposes this additional file serves." }, "type": { "type": "string", "description": "Type of the additional file." }, "fileName": { "type": "string", "description": "File name of the additional file." }, "subtitleDisplayName": { "type": "string", "description": "Display name of the subtitle, when this additional file is a subtitle." }, "subtitleLanguageName": { "type": "string", "description": "Language name of the subtitle, when this additional file is a subtitle." }, "subtitleLanguageCode": { "type": "string", "description": "Language code of the subtitle, when this additional file is a subtitle." }, "subtitleIsTranscript": { "type": "string", "description": "Indicates whether the subtitle is a transcript." } }, "description": "An additional file (e.g. subtitle, crop, or other supplementary asset) associated with a file version." }, "AdditionalFilePreviewCollectionResource": { "title": "Additional file preview collection resource", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/AdditionalFilePreviewResource" }, "description": "A collection of resource items." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of a non-paged collection of additional file previews" }, "AdditionalFilePreviewResource": { "title": "Additional file preview resource", "type": "object", "properties": { "id": { "type": "integer", "description": "Id of this preview.", "format": "int64" }, "metadata": { "type": "array", "items": { "type": "string" }, "description": "Metadata of this preview." }, "uri": { "type": "string", "description": "Returns a path to a preview file or null if no preview file is assigned. Opt-in: returned only when requested. Include via a \"select-additionalfilepreview: Uri\" header." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of a single preview of an additional file" }, "AdditionalFileResource": { "title": "Additional file resource", "type": "object", "properties": { "id": { "type": "string", "description": "Identifier for this additional file.", "format": "uuid" }, "type": { "description": "Type of this additional file. On the additional files collection endpoint, the results can be restricted to specific types with a \"select-additionalfile-type\" request header (comma-separated AdditionalFileType names).", "$ref": "#/components/schemas/AdditionalFileType" }, "isManual": { "type": "boolean", "description": "Returns true if this additional has been added manually. false is returned if the additional file was created automatically." }, "label": { "type": "string", "description": "Label of the additional file" }, "fileSize": { "type": "integer", "description": "File size of the additional file", "format": "int64" }, "fileName": { "type": "string", "description": "File name of the additional file" }, "extension": { "type": "string", "description": "File extension of the additional file" }, "tag": { "type": "string", "description": "Tag of the additional file Opt-in: returned only when requested. Include via a \"select-additionalfile: Tag\" header." }, "usages": { "type": "array", "items": { "type": "string" }, "description": "Usages of the additional file. On the additional files collection endpoint, the results can be restricted to specific usages with a \"select-additionalfile-usage\" request header (comma-separated values)." }, "uri": { "type": "string", "description": "Returns a path to image or if no image is assigned. This URL remains valid for four hours. Opt-in: returned only when requested. Include via a \"select-additionalfile: Uri\" header." }, "metadata": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Technical metadata specific to this additional file's type (e.g. video duration, image resolution). The available keys vary by file type and aren't individually documented. Opt-in: returned only when requested. Include via a \"select-additionalfile: Metadata\" header." }, "purposes": { "type": "array", "items": { "type": "string" }, "description": "Purposes of the additional file. On the additional files collection endpoint, the results can be restricted to specific purposes with a \"select-filter-purposes\" request header (comma-separated values)." }, "crc32": { "type": "integer", "description": "CRC32 checksum of this additional file.", "format": "int32" }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" }, "publicLink": { "description": "Relation to the addition file public link.", "$ref": "#/components/schemas/Link" }, "mainPreview": { "description": "Relation to an image of main preview with the size of a preview.", "$ref": "#/components/schemas/Link" }, "filePreviews": { "description": "Relation to a collection of file previews.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "publicLink": { "description": "Relation to the addition file public link. Embed via a \"select-additionalfile: publicLink\" header.", "$ref": "#/components/schemas/PublicLinkResource" }, "mainPreview": { "description": "Relation to an image of main preview with the size of a preview. Embed via a \"select-additionalfile: mainPreview\" header.", "$ref": "#/components/schemas/ImageResource" }, "filePreviews": { "description": "Relation to a collection of file previews. Embed via a \"select-additionalfile: filePreviews\" header.", "$ref": "#/components/schemas/AdditionalFilePreviewCollectionResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "An extra file stored alongside a file version's primary content - e.g. the original source file it was converted from, or a sidecar file - kept for reference rather than served as the record's main rendition." }, "AdditionalFileType": { "title": "Additional file type", "enum": [ "AdditionalFile", "OriginalRendition", "Crop", "Trim", "Still", "Spinset", "ThreeDimensional", "Subtitle", "External", "Custom", "VideoPersonThumbnail" ], "type": "string", "x-enum-descriptions": [ "Represents an additional file without specific type", "Represents the original rendition of a file.", "Represents a crop", "Represents a trim", "Represents a still", "Represents a spinset", "Represents a 3D representation", "Represents a subtitle file", "Represents an external additional file", "Represents a custom additional file", "Represents an AI detected face-crop thumbnail from Video" ] }, "AdditionalFilesModel": { "title": "Additional files model", "type": "object", "properties": { "addOrUpdate": { "type": "array", "items": { "$ref": "#/components/schemas/AdditionalFileModel" }, "description": "The additional files to add or update." }, "remove": { "type": "array", "items": { "$ref": "#/components/schemas/AdditionalFileModel" }, "description": "The additional files to remove." } }, "description": "Collection of additional files to add, update, or remove on a file version." }, "AkamaiCdnOrderCreateCommand": { "title": "Akamai cdn order create command", "type": "object", "properties": { "targets": { "type": "array", "items": { "$ref": "#/components/schemas/AkamaiCdnOrderTargetModel" }, "description": "Records and renditions to publish to the Akamai CDN." }, "deliveryLocation": { "type": "string", "description": "Location where the order output is delivered." }, "includeTargets": { "type": "boolean", "description": "When set, includes the resolved order targets in the response." }, "disableProcessing": { "type": "string", "description": "When set, disables further processing of the order." }, "creatorEmail": { "type": "string", "description": "Email address of the user the job is created on behalf of." }, "disableNotification": { "type": "boolean", "description": "When set to true, suppresses notifications for this job." }, "earliestStartDate": { "type": [ "null", "string" ], "description": "Earliest date and time at which the job is allowed to start executing.", "format": "date-time" }, "priority": { "enum": [ "High", "Medium" ], "type": "string", "description": "Priority used to schedule this job relative to other maintenance jobs." }, "type": { "enum": [ "Classification", "Record", "ExportAuditTrail", "BulkRecord", "AcceptDownloadOrderAgreement", "BulkCollection", "ExportContentItemsList" ], "type": "string", "description": "Type of maintenance job to create." }, "actions": { "type": "array", "items": { "$ref": "#/components/schemas/ActionModel" }, "description": "Actions to execute for each target of this job." }, "title": { "type": "string", "description": "Title of the job. For a download or contact-sheet order this is shown on the Downloads page in Content Workspace; if omitted, it defaults to the file name, or \"X items\" when multiple files were ordered. Either plain text, or a JSON string of the form {\"studioName\":\"...\",\"moduleName\":\"...\",\"translationKey\":\"...\"} to look up a translated value for non-English users (see the Localization > Translations section of the DAM Administrator Guide for how translations are registered)." }, "description": { "type": "string", "description": "Description of the job. For a download or contact-sheet order this is shown on the Downloads page in Content Workspace; if omitted, it defaults to \"Download\". Accepts the same plain-text-or-translation-key JSON format as Title." }, "errorMode": { "type": "string", "description": "Determines how the job behaves when one of its targets fails to execute." } }, "description": "Payload for creating an order that publishes records to the Akamai CDN." }, "AkamaiCdnOrderResource": { "title": "Akamai cdn order resource", "type": "object", "properties": { "deliveredFiles": { "type": "array", "items": { "$ref": "#/components/schemas/DeliveredFileWithAdditionalParameters" }, "description": "Collection of delivered files with related target properties." }, "orderType": { "type": "string", "description": "Type of the order" }, "totalFileSize": { "type": "integer", "description": "Total file size of the delivered files", "format": "int64" }, "creatorEmail": { "type": "string", "description": "E-mail address for this job" }, "disableNotification": { "type": "boolean", "description": "Value indicating whether or not notification is enabled on this job" }, "earliestStartDate": { "type": [ "null", "string" ], "description": "The earliest date in utc time on which this job can be executed.", "format": "date-time" }, "executionTime": { "type": "string", "description": "Time it took for this maintenance job to execute." }, "id": { "type": "string", "description": "Id of this maintenance job.", "format": "uuid" }, "type": { "type": "string", "description": "Name of this maintenance job." }, "priority": { "enum": [ "High", "Medium", "AuditArchiving", "BuildSearchIndex" ], "type": "string", "description": "Priority of this maintenance job." }, "startedOn": { "type": [ "null", "string" ], "description": "Time on which the execution of this maintenance job started in utc time.", "format": "date-time" }, "status": { "enum": [ "Pending", "Success", "Failed", "PartiallyFailed", "Executing", "Cancelled", "Scheduled", "Queued", "AsyncPending", "AsyncExecuting" ], "type": "string", "description": "Status of this maintenance job." }, "message": { "type": [ "null", "string" ], "description": "Error message that describes why this maintenance job failed. Returns null if this maintenance job hasn't been executed yet." }, "failedTargetsCount": { "type": "integer", "description": "Count of the failed targets.", "format": "int32" }, "createdOn": { "type": "string", "description": "Creation datetime in UTC time.", "format": "date-time" }, "_links": { "type": "object", "properties": { "targets": { "description": "Relation to a collection of order targets.", "$ref": "#/components/schemas/Link" }, "createdBy": { "description": "Relation to the user who created this maintenance job.", "$ref": "#/components/schemas/Link" }, "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "targets": { "description": "Relation to a collection of order targets. Embed via a \"select-order: targets\" header.", "$ref": "#/components/schemas/OrderTargetCollectionResource" }, "createdBy": { "description": "Relation to the user who created this maintenance job. Embed via a \"select-akamaicdnorder: createdBy\" header.", "$ref": "#/components/schemas/UserResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "Representation of an Akamai CDN order." }, "AkamaiCdnOrderTargetModel": { "title": "Akamai cdn order target model", "type": "object", "properties": { "renditionName": { "type": "string", "description": "Name of the rendition to include in the order." }, "recordId": { "type": "string", "description": "Id of the record to include in the order. Mutually exclusive with RecordIds; specify exactly one of the two.", "format": "uuid" }, "recordIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Ids of the records to include in a download order, as a faster alternative to RecordId that skips preloading each record when the order is created (they're only loaded when the order executes, so an invalid or inaccessible id fails or partially fails at that point instead of at creation time). Only valid for download orders; when used, TargetTypes is restricted to Document, AdditionalFiles and/or Renditions, and AssetType must be LatestVersionOfMasterFile. Mutually exclusive with RecordId." }, "fileVersionId": { "type": [ "null", "string" ], "description": "Id of the specific file version to include in the order.", "format": "uuid" }, "additionalFileId": { "type": [ "null", "string" ], "description": "Id of the specific additional file to include in the order.", "format": "uuid" }, "renditionId": { "type": [ "null", "string" ], "description": "Id of the specific rendition to include in the order.", "format": "uuid" }, "assetType": { "description": "Which version(s) of the record's file(s) to include in the order.", "$ref": "#/components/schemas/RecordAssetType" }, "targetTypes": { "type": "array", "items": { "$ref": "#/components/schemas/RecordTargetType" }, "description": "Which file types (document, thumbnail, preview, etc.) to include in the order." }, "actions": { "type": "array", "items": { "$ref": "#/components/schemas/ActionModel" }, "description": "Maintenance actions to run for this target." }, "filter": { "description": "Filter used to narrow down which files of the target record(s) are included in the order.", "$ref": "#/components/schemas/OrderTargetModelFilter" }, "forceRetry": { "type": "boolean", "description": "When set to true, forces this target to be retried even if it previously failed." }, "tag": { "type": "string", "description": "Free-form tag that can be used to identify or group this target." } }, "description": "Order target for an Akamai CDN order, identifying the record and rendition to publish." }, "AnnotationCreateCommand": { "title": "Annotation create command", "type": "object", "properties": { "id": { "type": "string", "description": "Identifier of the annotation.", "format": "uuid" }, "fileVersionId": { "type": "string", "description": "Identifier of the file version the annotation is placed on.", "format": "uuid" }, "pageNumber": { "type": "integer", "description": "Page number the annotation is placed on.", "format": "int32" }, "comments": { "type": "string", "description": "Comment text for the annotation." }, "xfdfString": { "type": "string", "description": "XFDF markup describing the annotation's shape and position." }, "parentAnnotationId": { "type": [ "null", "string" ], "description": "Identifier of the parent annotation, when this annotation is a reply.", "format": "uuid" }, "taggedUserIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Identifiers of the users tagged in this annotation." }, "collectionId": { "type": [ "null", "string" ], "description": "Identifier of the collection this annotation belongs to.", "format": "uuid" }, "createdBy": { "type": [ "null", "string" ], "description": "Identifier of the user who created the annotation.", "format": "uuid" } }, "description": "Creates a new annotation on a file version." }, "AnnotationPagedCollectionResource": { "title": "Annotation paged collection resource", "type": "object", "properties": { "pageNumber": { "type": [ "null", "integer" ], "description": "The current page of this paged collection.", "format": "int32" }, "pageSize": { "type": [ "null", "integer" ], "description": "The current page size of this paged collection.", "format": "int32" }, "skip": { "type": [ "null", "integer" ], "description": "The current skip size of this paged collection.", "format": "int32" }, "take": { "type": [ "null", "integer" ], "description": "The current take size of this paged collection.", "format": "int32" }, "totalCount": { "type": "integer", "description": "The total count of items in this paged collection, not just on the current page.", "format": "int64" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/AnnotationResource" }, "description": "One page of this paged collection, which is a subcollection of the complete collection." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" }, "first": { "description": "A link to the first page of this paged collection.", "$ref": "#/components/schemas/Link" }, "prev": { "description": "A link to the previous page of this paged collection.", "$ref": "#/components/schemas/Link" }, "next": { "description": "A link to the next page of this paged collection.", "$ref": "#/components/schemas/Link" }, "last": { "description": "A link to the last page of this paged collection.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of a paged collection of annotations" }, "AnnotationResource": { "title": "Annotation resource", "type": "object", "properties": { "id": { "type": "string", "description": "The Id of this annotation.", "format": "uuid" }, "fileVersionId": { "type": "string", "description": "The File Version Id of this annotation.", "format": "uuid" }, "parentAnnotationId": { "type": [ "null", "string" ], "description": "The Parent Annotation Id of this annotation.", "format": "uuid" }, "collectionId": { "type": [ "null", "string" ], "description": "The Collection Id of this annotation.", "format": "uuid" }, "pageNumber": { "type": "integer", "description": "The Page Number of this annotation.", "format": "int32" }, "comments": { "type": "string", "description": "The plain-text comment." }, "xfdfString": { "type": "string", "description": "XFDF markup describing the annotation's shape and position on the page." }, "createdBy": { "type": "string", "description": "The creator id of this annotation", "format": "uuid" }, "modifiedBy": { "type": "string", "description": "The modifier id of this annotation", "format": "uuid" }, "createdOn": { "type": "string", "description": "The date when this annotation was created", "format": "date-time" }, "modifiedOn": { "type": "string", "description": "The date when this annotation was updated", "format": "date-time" }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "A plain-text comment and/or XFDF markup attached to a specific page of a file version, optionally threaded as a reply to another annotation - used for collaborative review of documents." }, "ApiErrorContent": { "title": "Api error content", "type": "object", "properties": { "exceptionType": { "type": "string", "description": "The fully qualified exception type that caused this response." }, "exceptionMessage": { "type": "string", "description": "A human-readable message describing the error." } }, "description": "The JSON body returned for a non-2xx response, describing the error that occurred." }, "AppendTextFieldActionParametersModel": { "title": "Append text field action parameters model", "type": "object", "properties": { "fieldId": { "type": "string", "description": "Id of the field to append to.", "format": "uuid" }, "value": { "type": "string", "description": "Text to append." }, "languageId": { "type": "string", "description": "Language of the field value, for multilingual fields.", "format": "uuid" } }, "description": "Parameters for the \"AppendTextField\" maintenance job action." }, "AppendToFieldActionParametersModel": { "title": "Append to field action parameters model", "type": "object", "properties": { "fieldId": { "type": "string", "description": "Id of the field to append to.", "format": "uuid" }, "value": { "type": "string", "description": "Value to append." }, "languageId": { "type": "string", "description": "Language of the field value, for multilingual fields.", "format": "uuid" } }, "description": "Parameters for the \"AppendToField\" maintenance job action." }, "ApplyWatermarkOnMasterFileNonResource": { "title": "Apply watermark on master file non resource", "type": "object", "properties": { "watermarkType": { "description": "Watermark type to apply", "$ref": "#/components/schemas/FileWatermarkType" }, "watermarkId": { "type": [ "null", "string" ], "description": "Watermark ID to apply", "format": "uuid" }, "index": { "type": "integer", "description": "Index of a rule action in collection", "format": "int32" }, "actionType": { "description": "Data type of this rule action", "$ref": "#/components/schemas/RuleActionDataType" }, "executionTime": { "description": "Execution time of the rule action", "$ref": "#/components/schemas/RuleExecutionTime" } }, "description": "Representation of ApplyWatermarkOnMasterFile rule action" }, "ApplyWatermarkOnMasterFileRuleActionModel": { "title": "Apply watermark on master file rule action model", "type": "object", "properties": { "watermarkId": { "type": [ "null", "string" ], "description": "Id of the watermark to apply, used when watermarkType is UseSpecified.", "format": "uuid" }, "watermarkType": { "description": "How the watermark to apply is selected. See FileWatermarkType.", "$ref": "#/components/schemas/FileWatermarkType" }, "index": { "type": "integer", "description": "Index of the action within the rule's action collection", "format": "int32" }, "actionType": { "description": "Type of action to be executed.", "$ref": "#/components/schemas/RuleActionDataType" }, "executionTime": { "description": "When the action should be executed.", "$ref": "#/components/schemas/RuleExecutionTime" } }, "description": "Model for ApplyWatermarkOnMasterFile rule action" }, "AprimoAIActionParametersModel": { "title": "Aprimo AI action parameters model", "type": "object", "properties": { "options": { "enum": [ "None", "SmartTags", "Faces", "CustomSmartTags", "Text", "Transcripts" ], "type": "string", "description": "Which Aprimo AI extraction options to run." } }, "description": "Parameters for the \"AprimoAI\" maintenance job action." }, "AprimoAIRuleActionModel": { "title": "Aprimo AI rule action model", "type": "object", "properties": { "options": { "description": "AI options to be executed", "$ref": "#/components/schemas/AIExtractionOptions" }, "index": { "type": "integer", "description": "Index of the action within the rule's action collection", "format": "int32" }, "actionType": { "description": "Type of action to be executed.", "$ref": "#/components/schemas/RuleActionDataType" }, "executionTime": { "description": "When the action should be executed.", "$ref": "#/components/schemas/RuleExecutionTime" } }, "description": "Model for AprimoAI rule action" }, "AprimoAIRuleActionNonResource": { "title": "Aprimo AI rule action non resource", "type": "object", "properties": { "options": { "description": "Controls which Aprimo AI features to run.", "$ref": "#/components/schemas/AIExtractionOptions" }, "index": { "type": "integer", "description": "Index of a rule action in collection", "format": "int32" }, "actionType": { "description": "Data type of this rule action", "$ref": "#/components/schemas/RuleActionDataType" }, "executionTime": { "description": "Execution time of the rule action", "$ref": "#/components/schemas/RuleExecutionTime" } }, "description": "Representation of Aprimo AI rule action" }, "AprimoAIUpdatePerformanceRuleActionModel": { "title": "Aprimo AI update performance rule action model", "type": "object", "properties": { "index": { "type": "integer", "description": "Index of the action within the rule's action collection", "format": "int32" }, "actionType": { "description": "Type of action to be executed.", "$ref": "#/components/schemas/RuleActionDataType" }, "executionTime": { "description": "When the action should be executed.", "$ref": "#/components/schemas/RuleExecutionTime" } }, "description": "Model for AprimoAIUpdatePerformance rule action" }, "AprimoAIUpdatePerformanceRuleActionNonResource": { "title": "Aprimo AI update performance rule action non resource", "type": "object", "properties": { "index": { "type": "integer", "description": "Index of a rule action in collection", "format": "int32" }, "actionType": { "description": "Data type of this rule action", "$ref": "#/components/schemas/RuleActionDataType" }, "executionTime": { "description": "Execution time of the rule action", "$ref": "#/components/schemas/RuleExecutionTime" } }, "description": "Updates the performance of the custom tags. Should only be used with a condition on update of the AprimoAI_Custom_Tags field." }, "AuditEntryIdResource": { "title": "Audit entry id resource", "type": "object", "properties": { "id": { "type": "integer", "description": "The identifier of this audit log entry.", "format": "int64" }, "objectId": { "type": "string", "description": "The identifier of the object this audit entry describes.", "format": "uuid" }, "userId": { "type": "string", "description": "The identifier of the user who made the change.", "format": "uuid" }, "externalUserName": { "type": "string", "description": "External identifier of a user, in case it isn't a DAM user." }, "createdOn": { "type": "string", "description": "The date and time the change was recorded, in UTC.", "format": "date-time" }, "changeCount": { "type": "integer", "description": "The number of individual field changes recorded in this entry.", "format": "int32" }, "changes": { "type": "array", "items": { "type": "string" }, "description": "The individual field changes recorded in this entry." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "A single audit log entry describing one change made to an object, including who made it, when, and what changed." }, "AuditEntryResource": { "title": "Audit entry resource", "type": "object", "properties": { "objectId": { "type": "string", "description": "Audit object id.", "format": "uuid" }, "entryCount": { "type": "integer", "description": "Total entry count.", "format": "int32" }, "entries": { "type": "array", "items": { "type": "string" }, "description": "List of entries." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "The audit trail for a single object, containing the total number of recorded change entries and a page of the entries themselves." }, "BooleanOperatorType": { "title": "Boolean operator type", "enum": [ "And", "Or", "Not" ], "type": "string" }, "BooleanSettingDefinitionCreateCommand": { "title": "Boolean setting definition create command", "type": "object", "properties": { "defaultValue": { "type": "boolean", "description": "Default value for this boolean setting definition." }, "dataType": { "description": "Data type of the setting definition to create. Determines which additional properties apply.", "$ref": "#/components/schemas/SettingDefinitionType" }, "name": { "type": "string", "description": "Name of this setting definition." }, "categoryId": { "type": "string", "description": "Id of the setting category this setting definition belongs to.", "format": "uuid" }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelModel" }, "description": "Multi-language labels for the name of this setting definition." }, "allowSystemSetting": { "type": "boolean", "description": "When set, allows this setting to be configured at the system level." }, "allowUserSetting": { "type": "boolean", "description": "When set, allows this setting to be configured at the user level." }, "roleRequiredForChange": { "type": "string", "description": "Name of the role required to change settings of this definition." }, "userGroupSettingMode": { "enum": [ "None", "MaximumValue", "MinimumValue", "Manual", "FirstValue" ], "type": "string", "description": "Algorithm used to calculate the effective value for user group settings of this definition." }, "helpUrl": { "type": "string", "description": "URL to help documentation for this setting definition." }, "tag": { "type": "string", "description": "Free-form tag for this setting definition." } }, "description": "Creates a new boolean setting definition." }, "BooleanSettingDefinitionResource": { "title": "Boolean setting definition resource", "type": "object", "properties": { "defaultValue": { "type": "boolean", "description": "Default value of the setting" }, "id": { "type": "string", "description": "Id of the setting definition", "format": "uuid" }, "helpUrl": { "type": "string", "description": "Help url for the setting definition" }, "userGroupSettingMode": { "enum": [ "None", "MaximumValue", "MinimumValue", "Manual", "FirstValue" ], "type": "string", "description": "UserGroupSettingMode for the setting definition" }, "categoryId": { "type": "string", "description": "Category Id for the setting definition", "format": "uuid" }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelNonResource" }, "description": "Collection of labels for the setting definition" }, "allowSystemSetting": { "type": "boolean", "description": "Indicates whether this setting can be configured at the system level." }, "allowUserSetting": { "type": "boolean", "description": "Indicates whether this setting can be configured per user." }, "roleRequiredForChange": { "type": "string", "description": "Role that needs to be changed" }, "name": { "type": "string", "description": "Name of the setting definition" }, "dataType": { "enum": [ "None", "Boolean", "Text", "Numeric", "DateTime", "Xml", "Role", "Reference", "EncryptedText", "DefSchema" ], "type": "string", "description": "Data type of this setting" }, "tag": { "type": "string", "description": "Tag for this setting containing extra information. Opt-in: returned only when requested. Include via a \"select-settingdefinition: Tag\" header." }, "modifiedOn": { "type": "string", "description": "Last modification datetime in UTC time.", "format": "date-time" }, "createdOn": { "type": "string", "description": "Creation datetime in UTC time.", "format": "date-time" }, "_links": { "type": "object", "properties": { "modifiedBy": { "description": "Relation to the user who last modified this settingdefinition.", "$ref": "#/components/schemas/Link" }, "createdBy": { "description": "Relation to the user who created this settingdefinition.", "$ref": "#/components/schemas/Link" }, "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "modifiedBy": { "description": "Relation to the user who last modified this settingdefinition. Embed via a \"select-booleansettingdefinition: modifiedBy\" header.", "$ref": "#/components/schemas/UserResource" }, "createdBy": { "description": "Relation to the user who created this settingdefinition. Embed via a \"select-booleansettingdefinition: createdBy\" header.", "$ref": "#/components/schemas/UserResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "Representation of a BooleanSettingDefinition resource." }, "BrandTemplateOrderCreateCommand": { "title": "Brand template order create command", "type": "object", "properties": { "customizationId": { "type": "string", "description": "Id of the brand template customization to use for this order.", "format": "uuid" }, "presets": { "type": "array", "items": { "type": "string" }, "description": "Names of the presets to generate for this order." }, "authorizationHeader": { "type": "string", "description": "Authorization header value used when calling the external service for this order." }, "deliveryLocation": { "type": "string", "description": "Location where the order output is delivered." }, "includeTargets": { "type": "boolean", "description": "When set, includes the resolved order targets in the response." }, "disableProcessing": { "type": "string", "description": "When set, disables further processing of the order." }, "creatorEmail": { "type": "string", "description": "Email address of the user the job is created on behalf of." }, "disableNotification": { "type": "boolean", "description": "When set to true, suppresses notifications for this job." }, "earliestStartDate": { "type": [ "null", "string" ], "description": "Earliest date and time at which the job is allowed to start executing.", "format": "date-time" }, "priority": { "enum": [ "High", "Medium" ], "type": "string", "description": "Priority used to schedule this job relative to other maintenance jobs." }, "type": { "enum": [ "Classification", "Record", "ExportAuditTrail", "BulkRecord", "AcceptDownloadOrderAgreement", "BulkCollection", "ExportContentItemsList" ], "type": "string", "description": "Type of maintenance job to create." }, "targets": { "type": "array", "items": { "$ref": "#/components/schemas/OrderTargetModel" }, "description": "Targets the job's actions are applied to." }, "actions": { "type": "array", "items": { "$ref": "#/components/schemas/ActionModel" }, "description": "Actions to execute for each target of this job." }, "title": { "type": "string", "description": "Title of the job. For a download or contact-sheet order this is shown on the Downloads page in Content Workspace; if omitted, it defaults to the file name, or \"X items\" when multiple files were ordered. Either plain text, or a JSON string of the form {\"studioName\":\"...\",\"moduleName\":\"...\",\"translationKey\":\"...\"} to look up a translated value for non-English users (see the Localization > Translations section of the DAM Administrator Guide for how translations are registered)." }, "description": { "type": "string", "description": "Description of the job. For a download or contact-sheet order this is shown on the Downloads page in Content Workspace; if omitted, it defaults to \"Download\". Accepts the same plain-text-or-translation-key JSON format as Title." }, "errorMode": { "type": "string", "description": "Determines how the job behaves when one of its targets fails to execute." } }, "description": "Payload for creating an order that generates output from a brand template." }, "BrandTemplateOrderResource": { "title": "Brand template order resource", "type": "object", "properties": { "customizationId": { "type": "string", "description": "The brand template customization id", "format": "uuid" }, "presets": { "type": "array", "items": { "type": "string" }, "description": "The requested presets" }, "orderType": { "type": "string", "description": "Type of the order" }, "deliveredFiles": { "type": "array", "items": { "type": "string" }, "description": "The files delivered to the client by this order." }, "totalFileSize": { "type": "integer", "description": "Total file size of the delivered files", "format": "int64" }, "creatorEmail": { "type": "string", "description": "E-mail address for this job" }, "disableNotification": { "type": "boolean", "description": "Value indicating whether or not notification is enabled on this job" }, "earliestStartDate": { "type": [ "null", "string" ], "description": "The earliest date in utc time on which this job can be executed.", "format": "date-time" }, "executionTime": { "type": "string", "description": "Time it took for this maintenance job to execute." }, "id": { "type": "string", "description": "Id of this maintenance job.", "format": "uuid" }, "type": { "type": "string", "description": "Name of this maintenance job." }, "priority": { "enum": [ "High", "Medium", "AuditArchiving", "BuildSearchIndex" ], "type": "string", "description": "Priority of this maintenance job." }, "startedOn": { "type": [ "null", "string" ], "description": "Time on which the execution of this maintenance job started in utc time.", "format": "date-time" }, "status": { "enum": [ "Pending", "Success", "Failed", "PartiallyFailed", "Executing", "Cancelled", "Scheduled", "Queued", "AsyncPending", "AsyncExecuting" ], "type": "string", "description": "Status of this maintenance job." }, "message": { "type": [ "null", "string" ], "description": "Error message that describes why this maintenance job failed. Returns null if this maintenance job hasn't been executed yet." }, "failedTargetsCount": { "type": "integer", "description": "Count of the failed targets.", "format": "int32" }, "createdOn": { "type": "string", "description": "Creation datetime in UTC time.", "format": "date-time" }, "_links": { "type": "object", "properties": { "targets": { "description": "Relation to a collection of order targets.", "$ref": "#/components/schemas/Link" }, "createdBy": { "description": "Relation to the user who created this maintenance job.", "$ref": "#/components/schemas/Link" }, "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "targets": { "description": "Relation to a collection of order targets. Embed via a \"select-order: targets\" header.", "$ref": "#/components/schemas/OrderTargetCollectionResource" }, "createdBy": { "description": "Relation to the user who created this maintenance job. Embed via a \"select-brandtemplateorder: createdBy\" header.", "$ref": "#/components/schemas/UserResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "Representation of a brand template order." }, "BrandTemplatePreprocessingOrderCreateCommand": { "title": "Brand template preprocessing order create command", "type": "object", "properties": { "authorizationHeader": { "type": "string", "description": "Authorization header value used when calling the external service for this order." }, "deliveryLocation": { "type": "string", "description": "Location where the order output is delivered." }, "includeTargets": { "type": "boolean", "description": "When set, includes the resolved order targets in the response." }, "disableProcessing": { "type": "string", "description": "When set, disables further processing of the order." }, "creatorEmail": { "type": "string", "description": "Email address of the user the job is created on behalf of." }, "disableNotification": { "type": "boolean", "description": "When set to true, suppresses notifications for this job." }, "earliestStartDate": { "type": [ "null", "string" ], "description": "Earliest date and time at which the job is allowed to start executing.", "format": "date-time" }, "priority": { "enum": [ "High", "Medium" ], "type": "string", "description": "Priority used to schedule this job relative to other maintenance jobs." }, "type": { "enum": [ "Classification", "Record", "ExportAuditTrail", "BulkRecord", "AcceptDownloadOrderAgreement", "BulkCollection", "ExportContentItemsList" ], "type": "string", "description": "Type of maintenance job to create." }, "targets": { "type": "array", "items": { "$ref": "#/components/schemas/OrderTargetModel" }, "description": "Targets the job's actions are applied to." }, "actions": { "type": "array", "items": { "$ref": "#/components/schemas/ActionModel" }, "description": "Actions to execute for each target of this job." }, "title": { "type": "string", "description": "Title of the job. For a download or contact-sheet order this is shown on the Downloads page in Content Workspace; if omitted, it defaults to the file name, or \"X items\" when multiple files were ordered. Either plain text, or a JSON string of the form {\"studioName\":\"...\",\"moduleName\":\"...\",\"translationKey\":\"...\"} to look up a translated value for non-English users (see the Localization > Translations section of the DAM Administrator Guide for how translations are registered)." }, "description": { "type": "string", "description": "Description of the job. For a download or contact-sheet order this is shown on the Downloads page in Content Workspace; if omitted, it defaults to \"Download\". Accepts the same plain-text-or-translation-key JSON format as Title." }, "errorMode": { "type": "string", "description": "Determines how the job behaves when one of its targets fails to execute." } }, "description": "Payload for creating an order that runs brand template preprocessing." }, "BrandTemplatePreprocessingOrderResource": { "title": "Brand template preprocessing order resource", "type": "object", "properties": { "orderType": { "type": "string", "description": "Type of the order" }, "deliveredFiles": { "type": "array", "items": { "type": "string" }, "description": "The files delivered to the client by this order." }, "totalFileSize": { "type": "integer", "description": "Total file size of the delivered files", "format": "int64" }, "creatorEmail": { "type": "string", "description": "E-mail address for this job" }, "disableNotification": { "type": "boolean", "description": "Value indicating whether or not notification is enabled on this job" }, "earliestStartDate": { "type": [ "null", "string" ], "description": "The earliest date in utc time on which this job can be executed.", "format": "date-time" }, "executionTime": { "type": "string", "description": "Time it took for this maintenance job to execute." }, "id": { "type": "string", "description": "Id of this maintenance job.", "format": "uuid" }, "type": { "type": "string", "description": "Name of this maintenance job." }, "priority": { "enum": [ "High", "Medium", "AuditArchiving", "BuildSearchIndex" ], "type": "string", "description": "Priority of this maintenance job." }, "startedOn": { "type": [ "null", "string" ], "description": "Time on which the execution of this maintenance job started in utc time.", "format": "date-time" }, "status": { "enum": [ "Pending", "Success", "Failed", "PartiallyFailed", "Executing", "Cancelled", "Scheduled", "Queued", "AsyncPending", "AsyncExecuting" ], "type": "string", "description": "Status of this maintenance job." }, "message": { "type": [ "null", "string" ], "description": "Error message that describes why this maintenance job failed. Returns null if this maintenance job hasn't been executed yet." }, "failedTargetsCount": { "type": "integer", "description": "Count of the failed targets.", "format": "int32" }, "createdOn": { "type": "string", "description": "Creation datetime in UTC time.", "format": "date-time" }, "_links": { "type": "object", "properties": { "targets": { "description": "Relation to a collection of order targets.", "$ref": "#/components/schemas/Link" }, "createdBy": { "description": "Relation to the user who created this maintenance job.", "$ref": "#/components/schemas/Link" }, "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "targets": { "description": "Relation to a collection of order targets. Embed via a \"select-order: targets\" header.", "$ref": "#/components/schemas/OrderTargetCollectionResource" }, "createdBy": { "description": "Relation to the user who created this maintenance job. Embed via a \"select-brandtemplatepreprocessingorder: createdBy\" header.", "$ref": "#/components/schemas/UserResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "Representation of a brand template preprocessing order." }, "BulkCollectionMaintenanceJobCommand": { "title": "Bulk collection maintenance job command", "type": "object", "properties": { "creatorEmail": { "type": "string", "description": "Email address of the user the job is created on behalf of." }, "disableNotification": { "type": "boolean", "description": "When set to true, suppresses notifications for this job." }, "earliestStartDate": { "type": [ "null", "string" ], "description": "Earliest date and time at which the job is allowed to start executing.", "format": "date-time" }, "priority": { "enum": [ "High", "Medium" ], "type": "string", "description": "Priority used to schedule this job relative to other maintenance jobs." }, "type": { "enum": [ "Classification", "Record", "ExportAuditTrail", "BulkRecord", "AcceptDownloadOrderAgreement", "BulkCollection", "ExportContentItemsList" ], "type": "string", "description": "Type of maintenance job to create." }, "targets": { "type": "array", "items": { "$ref": "#/components/schemas/BulkCollectionMaintenanceJobTargetModel" }, "description": "Targets the job's actions are applied to." }, "actions": { "type": "array", "items": { "$ref": "#/components/schemas/ActionModel" }, "description": "Actions to execute for each target of this job." }, "title": { "type": "string", "description": "Title of the job. For a download or contact-sheet order this is shown on the Downloads page in Content Workspace; if omitted, it defaults to the file name, or \"X items\" when multiple files were ordered. Either plain text, or a JSON string of the form {\"studioName\":\"...\",\"moduleName\":\"...\",\"translationKey\":\"...\"} to look up a translated value for non-English users (see the Localization > Translations section of the DAM Administrator Guide for how translations are registered)." }, "description": { "type": "string", "description": "Description of the job. For a download or contact-sheet order this is shown on the Downloads page in Content Workspace; if omitted, it defaults to \"Download\". Accepts the same plain-text-or-translation-key JSON format as Title." }, "errorMode": { "type": "string", "description": "Determines how the job behaves when one of its targets fails to execute." } }, "description": "Creates a maintenance job that executes its actions against multiple collections." }, "BulkCollectionMaintenanceJobTargetModel": { "title": "Bulk collection maintenance job target model", "type": "object", "properties": { "collectionIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Ids of the collections this job's actions are applied to." }, "forceRetry": { "type": "boolean", "description": "When set to true, forces this target to be retried even if it previously failed." }, "tag": { "type": "string", "description": "Free-form tag that can be used to identify or group this target." } }, "description": "Target for a bulk collection maintenance job." }, "BulkEditReadItemsModel": { "title": "Bulk edit read items model", "type": "object", "properties": { "tokens": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Edit session tokens of the records included in the bulk edit." } }, "description": "Represents the request body for reading bulk edit field list values." }, "BulkRecordMaintenanceJobCommand": { "title": "Bulk record maintenance job command", "type": "object", "properties": { "creatorEmail": { "type": "string", "description": "Email address of the user the job is created on behalf of." }, "disableNotification": { "type": "boolean", "description": "When set to true, suppresses notifications for this job." }, "earliestStartDate": { "type": [ "null", "string" ], "description": "Earliest date and time at which the job is allowed to start executing.", "format": "date-time" }, "priority": { "enum": [ "High", "Medium" ], "type": "string", "description": "Priority used to schedule this job relative to other maintenance jobs." }, "type": { "enum": [ "Classification", "Record", "ExportAuditTrail", "BulkRecord", "AcceptDownloadOrderAgreement", "BulkCollection", "ExportContentItemsList" ], "type": "string", "description": "Type of maintenance job to create." }, "targets": { "type": "array", "items": { "$ref": "#/components/schemas/BulkRecordMaintenanceJobTargetModel" }, "description": "Targets the job's actions are applied to." }, "actions": { "type": "array", "items": { "$ref": "#/components/schemas/ActionModel" }, "description": "Actions to execute for each target of this job." }, "title": { "type": "string", "description": "Title of the job. For a download or contact-sheet order this is shown on the Downloads page in Content Workspace; if omitted, it defaults to the file name, or \"X items\" when multiple files were ordered. Either plain text, or a JSON string of the form {\"studioName\":\"...\",\"moduleName\":\"...\",\"translationKey\":\"...\"} to look up a translated value for non-English users (see the Localization > Translations section of the DAM Administrator Guide for how translations are registered)." }, "description": { "type": "string", "description": "Description of the job. For a download or contact-sheet order this is shown on the Downloads page in Content Workspace; if omitted, it defaults to \"Download\". Accepts the same plain-text-or-translation-key JSON format as Title." }, "errorMode": { "type": "string", "description": "Determines how the job behaves when one of its targets fails to execute." } }, "description": "Creates a maintenance job that executes its actions against multiple records." }, "BulkRecordMaintenanceJobTargetModel": { "title": "Bulk record maintenance job target model", "type": "object", "properties": { "recordIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Ids of the records this job's actions are applied to." }, "forceRetry": { "type": "boolean", "description": "When set to true, forces this target to be retried even if it previously failed." }, "tag": { "type": "string", "description": "Free-form tag that can be used to identify or group this target." } }, "description": "Target for a bulk record maintenance job." }, "CalculatedPermissionCollectionResource": { "title": "Calculated permission collection resource", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CalculatedPermissionResource" }, "description": "A collection of resource items." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of a collection of calculated permissions" }, "CalculatedPermissionResource": { "title": "Calculated permission resource", "type": "object", "properties": { "name": { "type": "string", "description": "Name of this permission." }, "value": { "enum": [ "None", "Granted", "Denied" ], "type": "string", "description": "Value of this permission." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "The effective permission level for a user on a resource, resolved when the user's direct permission and their user group's permission would otherwise conflict - DAM computes the winning value so a client doesn't have to reconcile the conflicting grants itself." }, "ChangeCollectionOwnerActionParametersModel": { "title": "Change collection owner action parameters model", "type": "object", "properties": { "newOwnerId": { "type": "string", "description": "Id of the user to become the collection's new owner.", "format": "uuid" } }, "description": "Parameters for the \"ChangeCollectionOwner\" maintenance job action." }, "ChangeCollectionStatusActionParametersModel": { "title": "Change collection status action parameters model", "type": "object", "properties": { "newStatus": { "type": "string", "description": "New status for the collection. One of \"Active\", \"Archive\", or \"Delete\" (this is a dedicated wire vocabulary, distinct from the internal CollectionStatus enum's own \"Archived\"/\"Deleted\" names)." } }, "description": "Parameters for the \"ChangeCollectionStatus\" maintenance job action." }, "ChangeContentTypeActionParametersModel": { "title": "Change content type action parameters model", "type": "object", "properties": { "contentType": { "type": "string", "description": "Name of the content type to change the record to." } }, "description": "Parameters for the \"ChangeContentType\" maintenance job action." }, "ChangeContentTypeRuleActionModel": { "title": "Change content type rule action model", "type": "object", "properties": { "contentType": { "type": "string", "description": "Content type name" }, "index": { "type": "integer", "description": "Index of the action within the rule's action collection", "format": "int32" }, "actionType": { "description": "Type of action to be executed.", "$ref": "#/components/schemas/RuleActionDataType" }, "executionTime": { "description": "When the action should be executed.", "$ref": "#/components/schemas/RuleExecutionTime" } } }, "ChangeContentTypeRuleActionNonResource": { "title": "Change content type rule action non resource", "type": "object", "properties": { "contentType": { "type": "string", "description": "The name of the content type to change the record to." }, "index": { "type": "integer", "description": "Index of a rule action in collection", "format": "int32" }, "actionType": { "description": "Data type of this rule action", "$ref": "#/components/schemas/RuleActionDataType" }, "executionTime": { "description": "Execution time of the rule action", "$ref": "#/components/schemas/RuleExecutionTime" } }, "description": "A rule action that changes the record's content type." }, "ChangeRecordStatusActionParametersModel": { "title": "Change record status action parameters model", "type": "object", "properties": { "status": { "enum": [ "Draft", "Released", "Archived", "Unpublished" ], "type": "string", "description": "New lifecycle status for the record." } }, "description": "Parameters for the \"ChangeRecordStatus\" maintenance job action." }, "ChangeRecordStatusRuleActionModel": { "title": "Change record status rule action model", "type": "object", "properties": { "status": { "type": "string", "description": "Status" }, "index": { "type": "integer", "description": "Index of the action within the rule's action collection", "format": "int32" }, "actionType": { "description": "Type of action to be executed.", "$ref": "#/components/schemas/RuleActionDataType" }, "executionTime": { "description": "When the action should be executed.", "$ref": "#/components/schemas/RuleExecutionTime" } } }, "ChangeRecordStatusRuleActionNonResource": { "title": "Change record status rule action non resource", "type": "object", "properties": { "status": { "type": "string", "description": "The new status to set on the record." }, "index": { "type": "integer", "description": "Index of a rule action in collection", "format": "int32" }, "actionType": { "description": "Data type of this rule action", "$ref": "#/components/schemas/RuleActionDataType" }, "executionTime": { "description": "Execution time of the rule action", "$ref": "#/components/schemas/RuleExecutionTime" } }, "description": "A rule action that changes the record's status." }, "CheckCategoryCollectionResource": { "title": "Check category collection resource", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CheckCategoryResource" }, "description": "A collection of non-resource items." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of a Check Category Collection" }, "CheckCategoryResource": { "title": "Check category resource", "type": "object", "properties": { "id": { "type": "string", "description": "Identifier for this check category.", "format": "uuid" }, "name": { "type": "string", "description": "Name of this check category." } }, "description": "A named grouping used to organize check definitions for display and filtering. Stock, non-customizable categories: Risk & Compliance, Brand Consistency, Message Clarity, Channel Readiness." }, "CheckCollectionResource": { "title": "Check collection resource", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CheckResource" }, "description": "A collection of resource items." }, "_links": { "type": "object", "properties": { "checks": { "description": "Relation to the checks in this collection.", "$ref": "#/components/schemas/Link" }, "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "checks": { "description": "Relation to the checks in this collection. Embed via a \"select-checkcollection: checks\" header.", "$ref": "#/components/schemas/CheckResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "Representation of a Check Collection" }, "CheckInResource": { "title": "Check in resource", "type": "object", "properties": { "operationToken": { "type": "string", "description": "Token to pass back in the OperationToken header to complete this check-in operation." }, "sasUrl": { "type": "string", "description": "SAS URL used to upload the file directly to Azure Storage." }, "previews": { "type": "array", "items": { "$ref": "#/components/schemas/UploadPreviewResource" }, "description": "Details about previews within check in operation" } }, "description": "Provides data about check in operation" }, "CheckOutResource": { "title": "Check out resource", "type": "object", "properties": { "operationToken": { "type": "string", "description": "Token to pass back in the OperationToken header to complete this checkout operation." } }, "description": "Provides data about checkout operation" }, "CheckOutStatusResource": { "title": "Check out status resource", "type": "object", "properties": { "status": { "enum": [ "Pending", "Success", "Failed", "PartiallyFailed", "Executing", "Cancelled", "Scheduled", "Queued", "AsyncPending", "AsyncExecuting" ], "type": "string", "description": "Status of this maintenance job." }, "deliveredFiles": { "type": "array", "items": { "type": "string" }, "description": "Names or URIs of the files that the order has delivered to the client." } }, "description": "Provides details about checkout progress" }, "CheckResource": { "title": "Check resource", "type": "object", "properties": { "id": { "type": "string", "description": "Identifier for this check.", "format": "uuid" }, "name": { "type": "string", "description": "Name of this check." }, "actionTypeId": { "type": "string", "description": "Action type identifier for this check.", "format": "uuid" }, "checkCategoryId": { "type": "string", "description": "Check category identifier for this check.", "format": "uuid" }, "checkCategoryName": { "type": "string", "description": "Check category name for this check." }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelNonResource" }, "description": "Collection of labels for this check." }, "createdOn": { "type": "string", "description": "Creation datetime in UTC time.", "format": "date-time" }, "_links": { "type": "object", "properties": { "createdBy": { "description": "Relation to the user who created this check.", "$ref": "#/components/schemas/Link" }, "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "createdBy": { "description": "Relation to the user who created this check. Embed via a \"select-check: createdBy\" header.", "$ref": "#/components/schemas/UserResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "A labeled, repeatable check definition (e.g. \"Brand Color Check\") that lets an external system run automated review checks (tone, brand color, logo, sizing, etc.) outside of Aprimo and write the results back so they surface to users in the platform. Checks are typically triggered by a DAM rule or a PM workflow status action webhook, which notifies the external system to fetch the content, run the check, and post the result back via this API. Create one, cache its Id, and reuse it every time that check runs." }, "ClassificationCollectionResource": { "title": "Classification collection resource", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ClassificationResource" }, "description": "A collection of resource items." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of a non-paged collection of classifications" }, "ClassificationCopyActionParametersModel": { "title": "Classification copy action parameters model", "type": "object", "properties": { "parentClassificationId": { "type": "string", "description": "Id of the classification to copy the target into.", "format": "uuid" }, "copySecurity": { "type": "boolean", "description": "When set, also copies security settings to the new classification." } }, "description": "Parameters for the \"ClassificationCopy\" maintenance job action." }, "ClassificationCreateCommand": { "title": "Classification create command", "type": "object", "properties": { "parentId": { "type": [ "null", "string" ], "description": "Identifier of the parent classification.", "format": "uuid" }, "parentNamePath": { "type": "string", "description": "Name path of the parent classification." }, "isRoot": { "type": [ "null", "boolean" ], "description": "When set, indicates whether the classification is a root classification." }, "tag": { "type": "string", "description": "Tag for the classification." }, "name": { "type": "string", "description": "Name of the classification." }, "identifier": { "type": "string", "description": "Unique identifier string for the classification." }, "sortIndex": { "type": "integer", "description": "Sort index used to order the classification among its siblings.", "format": "int32" }, "sortOrder": { "type": "string", "description": "Sort order used for the classification's children." }, "disabledInDAMUI": { "type": "boolean", "description": "Whether the classification is disabled in the DAM UI." }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelModel" }, "description": "Multi-language labels for the name of this classification." }, "slaveClassifications": { "description": "Slave classifications to add or remove.", "$ref": "#/components/schemas/EditableIdCollectionModel" }, "followerClassifications": { "description": "Follower classifications to add or remove.", "$ref": "#/components/schemas/EditableIdCollectionModel" }, "fields": { "description": "Field values for this classification.", "$ref": "#/components/schemas/FieldCollectionModel" }, "registeredFields": { "description": "Fields to register or unregister on this classification.", "$ref": "#/components/schemas/EditableIdCollectionModel" }, "registeredFieldGroups": { "description": "Field groups to register or unregister on this classification.", "$ref": "#/components/schemas/EditableIdCollectionModel" } }, "description": "Creates a new classification." }, "ClassificationDownloadPermissionsEditCommand": { "title": "Classification download permissions edit command", "type": "object", "properties": { "breakInheritance": { "type": "boolean", "description": "When set to true, breaks permission inheritance from the parent classification." }, "permissions": { "$ref": "#/components/schemas/DownloadPermissionsModel" } }, "description": "Updates the download permissions of a classification." }, "ClassificationDownloadPermissionsResource": { "title": "Classification download permissions resource", "type": "object", "properties": { "breakInheritance": { "type": "boolean", "description": "Value that indicates whether the record security inheritance chain is broken for the specified classification." }, "permissions": { "type": "array", "items": { "$ref": "#/components/schemas/ClassificationUserGroupDownloadPermissionNonResource" }, "description": "List of assigned record permissions per user group for the specified classification." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of a set of permissions linked to a classification" }, "ClassificationEditCommand": { "title": "Classification edit command", "type": "object", "properties": { "tag": { "type": "string", "description": "Tag for the classification." }, "name": { "type": "string", "description": "Name of the classification." }, "identifier": { "type": "string", "description": "Unique identifier string for the classification." }, "sortIndex": { "type": "integer", "description": "Sort index used to order the classification among its siblings.", "format": "int32" }, "sortOrder": { "type": "string", "description": "Sort order used for the classification's children." }, "disabledInDAMUI": { "type": "boolean", "description": "Whether the classification is disabled in the DAM UI." }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelModel" }, "description": "Multi-language labels for the name of this classification." }, "slaveClassifications": { "description": "Slave classifications to add or remove.", "$ref": "#/components/schemas/EditableIdCollectionModel" }, "followerClassifications": { "description": "Follower classifications to add or remove.", "$ref": "#/components/schemas/EditableIdCollectionModel" }, "fields": { "description": "Field values for this classification.", "$ref": "#/components/schemas/FieldCollectionModel" }, "registeredFields": { "description": "Fields to register or unregister on this classification.", "$ref": "#/components/schemas/EditableIdCollectionModel" }, "registeredFieldGroups": { "description": "Field groups to register or unregister on this classification.", "$ref": "#/components/schemas/EditableIdCollectionModel" } }, "description": "Updates an existing classification." }, "ClassificationFacetModel": { "title": "Classification facet model", "type": "object", "properties": { "facetRootId": { "type": [ "null", "string" ], "description": "The classification id used to determine which classifications are faceted on, in combination with Options.", "format": "uuid" }, "options": { "type": "array", "items": { "enum": [ "FacetRoot", "Children", "Descendants", "All" ], "type": "string" }, "description": "How FacetRootId is used to determine which classifications are faceted on. Defaults to FacetRoot." }, "directLinkedOnly": { "type": [ "null", "boolean" ], "description": "Determines if facet counts only take records into account that are directly linked to the facet classification, or also records linked to children/descendants of it." }, "maximumFacetValues": { "type": [ "null", "integer" ], "description": "Maximum number of facet values returned.", "format": "int32" }, "filters": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Filters allow you to limit the hits returned without affecting facets. If filters are specified, the aggregated counts in the facets remain the same. However, only records that match the filter criteria specified in the facet are returned. The parameter type of the filters depends on the facet type, but is always the same type as explicitValues/explicitRanges." }, "explicitValues": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "A list of values. When specified, only shows facets corresponding to the specified values. If not specified, all occurring values are included." }, "explicitRanges": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Allows for the explicit specification of ranges to include in the facet. If explicitRanges is specified, you cannot specify rangeStart, rangeEnd, or spans (on the concrete range facet type)." }, "name": { "type": "string", "description": "A textual identifier for this facet, used only by the client to correlate requests with responses." }, "type": { "enum": [ "NumericField", "NumericFieldRange", "Classification", "CreatedBy", "ModifiedBy", "FileType", "OptionListField", "TextField", "DateTimeFieldRange", "DateFieldRange", "CreatedOn", "ModifiedOn", "TimeFieldRange", "TextListField", "ContentType", "ClassificationListField", "DateFieldRangeFilter", "NumericFieldRangeFilter" ], "type": "string", "description": "Type of the facet. Depending on facet type, different parameters, combinations of parameters and parameter types are possible." } }, "description": "Facets on classification. You must specify either explicitValues (a list of classification ids) or facetRootId." }, "ClassificationGettingType": { "title": "Classification getting type", "enum": [ "Specified", "CalculatedByReference" ], "type": "string", "x-enum-descriptions": [ "The classification is specified directly", "The classification is calculated by reference" ] }, "ClassificationIdentifierType": { "title": "Classification identifier type", "enum": [ "NamePath", "Identifier" ], "type": "string", "x-enum-descriptions": [ "The classification is identified by its name path", "The classification is identified by its identifier" ] }, "ClassificationLinkedRuleConditionModel": { "title": "Classification linked rule condition model", "type": "object", "properties": { "directLinkOnly": { "type": "boolean", "description": "If true, only a direct link is considered" }, "classificationId": { "type": "string", "description": "Id of the classification to check", "format": "uuid" }, "index": { "type": "integer", "description": "Index of the condition within the rule's condition collection", "format": "int32" }, "conditionType": { "description": "Type of condition to be evaluated.", "$ref": "#/components/schemas/RuleConditionDataType" } }, "description": "Model for ClassificationLinked rule condition" }, "ClassificationLinkedRuleConditionNonResource": { "title": "Classification linked rule condition non resource", "type": "object", "properties": { "classificationId": { "type": "string", "description": "Classification id to link with", "format": "uuid" }, "directLinkOnly": { "type": "boolean", "description": "Specifies whether is directly linked or not" }, "index": { "type": "integer", "description": "Index of a rule condition in collection", "format": "int32" }, "conditionType": { "description": "Data type of this rule condition", "$ref": "#/components/schemas/RuleConditionDataType" } }, "description": "Representation of Classification linked rule" }, "ClassificationListFieldDefinitionCreateCommand": { "title": "Classification list field definition create command", "type": "object", "properties": { "acceptMultipleOptions": { "type": "boolean", "description": "When set to true, multiple classifications can be selected for this field." }, "linkRecordToSelectedClassifications": { "type": "boolean", "description": "When set to true, the record is linked to the selected classifications." }, "restrictValuesToLeafNodes": { "type": "boolean", "description": "When set to true, only leaf-node classifications can be selected." }, "rootId": { "type": "string", "description": "Id of the root classification restricting which classifications can be selected.", "format": "uuid" }, "defaultSelectionDisplayMode": { "enum": [ "Search", "Browse" ], "type": "string", "description": "Determines how classification selection is displayed by default." }, "filter": { "type": "string", "description": "Filter expression applied to restrict the available classifications." }, "metadataPredictionEnabled": { "type": "boolean", "description": "When set to true, this field's value can be predicted using AI-based metadata prediction." }, "hints": { "type": "string", "description": "Hints used to guide AI-based metadata prediction for this field." }, "dataType": { "description": "Data type of the field definition. Determines which other properties apply.", "$ref": "#/components/schemas/FieldDefinitionType" }, "enabledLanguages": { "description": "Languages in which this field is enabled. Use AddOrUpdate to add or update members, or Remove to remove them.", "$ref": "#/components/schemas/EditableIdCollectionModel" }, "indexed": { "type": "boolean", "description": "When set to true, the field is indexed for search." }, "inlineStyle": { "type": "string", "description": "Inline CSS style applied to the field in the DAM UI." }, "isReadOnly": { "type": "boolean", "description": "When set to true, the field cannot be edited." }, "isRequired": { "type": "boolean", "description": "When set to true, the field is required." }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelModel" }, "description": "Multi-language labels for the name of this field." }, "languageMode": { "type": "string", "description": "Language mode of the field." }, "memberships": { "description": "Field groups this field is a member of. Use AddOrUpdate to add or update members, or Remove to remove them.", "$ref": "#/components/schemas/EditableIdCollectionModel" }, "name": { "type": "string", "description": "Name of the field." }, "scope": { "type": "string", "description": "Scope of the field." }, "sortIndex": { "type": "integer", "description": "Sort index used to order the field relative to other fields.", "format": "int32" }, "tag": { "type": "string", "description": "Tag associated with the field." }, "defaultValue": { "type": "string", "description": "Default value assigned to the field." }, "resetToDefaultTriggers": { "type": "array", "items": { "type": "string" }, "description": "Names of the triggers that reset the field to its default value." }, "resetToDefaultFields": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Ids of the fields that reset this field to its default value when they change." }, "validation": { "type": "string", "description": "Validation expression applied to the field value." }, "validationErrorMessage": { "type": "string", "description": "Error message shown when validation fails." }, "validationTrigger": { "type": "string", "description": "Trigger that determines when validation is applied." }, "storageMode": { "type": "string", "description": "Storage mode of the field." }, "helpTexts": { "type": "array", "items": { "$ref": "#/components/schemas/HelpTextModel" }, "description": "Multi-language help texts for this field." } }, "description": "Command to create a classification list field definition." }, "ClassificationListFieldDefinitionResource": { "title": "Classification list field definition resource", "type": "object", "properties": { "acceptMultipleOptions": { "type": "boolean", "description": "Indicates if multiple value selection is allowed." }, "linkRecordToSelectedClassifications": { "type": "boolean", "description": "Indicates if the field is synchronized with the linked classifications of a record. It can't be changed once field definition is created." }, "restrictValuesToLeafNodes": { "type": "boolean", "description": "Indicates whether only the lowest level values should be used for this field." }, "rootId": { "type": "string", "description": "Id of the classification that is set as root for this field. If no root is specified it returns an empty guid.", "format": "uuid" }, "defaultSelectionDisplayMode": { "enum": [ "Search", "Browse" ], "type": "string", "description": "Classification display mode that is set as default in the selection dialog." }, "filter": { "type": "string", "description": "Filter of this field." }, "metadataPredictionEnabled": { "type": "boolean", "description": "Indicates whether the field can be predicted by the AI." }, "hints": { "type": "string", "description": "AI Prediction hint for this field." }, "label": { "type": "string", "description": "Label of this field." }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelNonResource" }, "description": "A collection of Label items." }, "dataType": { "$ref": "#/components/schemas/FieldDataType" }, "scope": { "enum": [ "RecordContentGlobal", "RecordContentClassDependent", "RecordContentFloating", "ClassificationProfileClassDependent", "UserGlobal", "FileFileTypeDependent", "FileFloating", "IndexerTaskGlobal", "FileGlobal", "ClassificationProfileFloating", "RecordContentContentTypeDependent" ], "type": "string", "description": "Scope." }, "scopeCategory": { "enum": [ "Record", "File", "Classification", "User", "IndexerTask", "MetadataTemplate" ], "type": "string", "description": "Scope category." }, "indexed": { "type": "boolean", "description": "Indicator if searching on this field is enabled." }, "languageMode": { "enum": [ "Single", "Multiple" ], "type": "string", "description": "Language mode of the field." }, "memberships": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Memberships of a field." }, "searchIndexRebuildRequired": { "type": "boolean", "description": "Indicator if a search index rebuild is required." }, "enabledLanguages": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Enabled languages." }, "id": { "type": "string", "description": "Identifier for this field.", "format": "uuid" }, "name": { "type": "string", "description": "Name for this field." }, "isRequired": { "type": "boolean", "description": "Indicates whether this field is required." }, "isReadOnly": { "type": "boolean", "description": "Indicates whether this field is read only." }, "isUniqueIdentifier": { "type": "boolean", "description": "Indicates whether this field is a unique identifier." }, "inlineStyle": { "type": "string", "description": "Inline CSS style applied to this field." }, "sortIndex": { "type": "integer", "description": "Sorting index of this field.", "format": "int32" }, "tag": { "type": "string", "description": "Tag for this field containing extra information. Opt-in: returned only when requested. Include via a \"select-fielddefinition: Tag\" header." }, "createdOn": { "type": "string", "description": "Created on the specified date in UTC time", "format": "date-time" }, "modifiedOn": { "type": "string", "description": "Modified on the specified date in UTC time", "format": "date-time" }, "defaultValue": { "type": "string", "description": "Default value of this field." }, "resetToDefaultTriggers": { "type": "array", "items": { "enum": [ "None", "OnNewField", "OnLoad", "OnSave", "OnAnyFileChange", "OnReclassifyRecord", "OnAnyChange", "OnFieldChange", "OnMasterFileChange", "OnCurrentFileChange", "OnFieldDefinitionChanged", "OnDuplicateRecord", "OnRecordStatusChange" ], "type": "string" }, "description": "'reset to default triggers' value of this field." }, "validation": { "type": "string", "description": "Validation of this field." }, "validationErrorMessage": { "type": "string", "description": "Error message of this field." }, "validationTrigger": { "enum": [ "None", "WhenNeeded", "Always" ], "type": "string", "description": "Trigger that determines when validation is evaluated for this field." }, "storageMode": { "enum": [ "None", "NonEmptyValues", "AllValues", "LogChanges" ], "type": "string", "description": "Storage mode of this field." }, "resetToDefaultFields": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Fields that trigger this field to be reset back to its default value. This is only used if \"ResetToDefaultTriggers\" is set to \"OnFieldChange\"." }, "helpText": { "type": "string", "description": "Help text of this field." }, "helpTexts": { "type": "array", "items": { "$ref": "#/components/schemas/HelpTextNonResource" }, "description": "A collection of HelpText items." }, "_links": { "type": "object", "properties": { "createdBy": { "description": "Relation to the user who created this field definition.", "$ref": "#/components/schemas/Link" }, "modifiedBy": { "description": "Relation to the user who last modified this field definition.", "$ref": "#/components/schemas/Link" }, "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "createdBy": { "description": "Relation to the user who created this field definition. Embed via a \"select-fielddefinition: createdBy\" header.", "$ref": "#/components/schemas/UserResource" }, "modifiedBy": { "description": "Relation to the user who last modified this field definition. Embed via a \"select-fielddefinition: modifiedBy\" header.", "$ref": "#/components/schemas/UserResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "Representation of the definition of a classification list field" }, "ClassificationListFieldFacetModel": { "title": "Classification list field facet model", "type": "object", "properties": { "maximumFacetValues": { "type": [ "null", "integer" ], "description": "Maximum number of facet values returned.", "format": "int32" }, "alwaysIncludeFiltersInFacetValues": { "type": [ "null", "boolean" ], "description": "Determines if the filters applied to this facet should always be part of the facet values. When maximumFacetValues is set and explicitValues is not and filters are applied, it is possible that the items being filtered on are not part of the facet values. Set this to true to prevent that. Defaults to false." }, "fieldId": { "type": [ "null", "string" ], "description": "The id of the field this facet should operate on.", "format": "uuid" }, "filters": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Filters allow you to limit the hits returned without affecting facets. If filters are specified, the aggregated counts in the facets remain the same. However, only records that match the filter criteria specified in the facet are returned. The parameter type of the filters depends on the facet type, but is always the same type as explicitValues/explicitRanges." }, "explicitValues": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "A list of values. When specified, only shows facets corresponding to the specified values. If not specified, all occurring values are included." }, "explicitRanges": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Allows for the explicit specification of ranges to include in the facet. If explicitRanges is specified, you cannot specify rangeStart, rangeEnd, or spans (on the concrete range facet type)." }, "name": { "type": "string", "description": "A textual identifier for this facet, used only by the client to correlate requests with responses." }, "type": { "enum": [ "NumericField", "NumericFieldRange", "Classification", "CreatedBy", "ModifiedBy", "FileType", "OptionListField", "TextField", "DateTimeFieldRange", "DateFieldRange", "CreatedOn", "ModifiedOn", "TimeFieldRange", "TextListField", "ContentType", "ClassificationListField", "DateFieldRangeFilter", "NumericFieldRangeFilter" ], "type": "string", "description": "Type of the facet. Depending on facet type, different parameters, combinations of parameters and parameter types are possible." } }, "description": "Facets on the classification-list items of a classification-list field." }, "ClassificationListFieldItemResource": { "title": "Classification list field item resource", "type": "object", "properties": { "id": { "type": "string", "description": "Identifier of this classification.", "format": "uuid" }, "identifier": { "type": "string", "description": "Identifier code of this classification." }, "name": { "type": "string", "description": "Name of this classification." }, "label": { "type": "string", "description": "Label of this classification." }, "namePath": { "type": "string", "description": "Full name path of this classification." }, "labelPath": { "type": "string", "description": "Full label path of this classification." }, "parentId": { "type": [ "null", "string" ], "description": "Identifier of the parent classification.", "format": "uuid" }, "disabledInDAMUI": { "type": "boolean", "description": "Value indicating whether this classification is disabled in the DAM UI." }, "hasChildren": { "type": [ "null", "boolean" ], "description": "Value indicating whether this classification has child classifications." }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelNonResource" }, "description": "A collection of Label items." }, "labelPaths": { "type": "array", "items": { "$ref": "#/components/schemas/LabelPathNonResource" }, "description": "Full label path of this classification in multiple languages. Opt-in: returned only when requested. Include via a \"select-classificationlistfielditem: LabelPaths\" header." } }, "description": "Representation of a Classification as possible filtered value for a ClassificationListField" }, "ClassificationListFieldResource": { "title": "Classification list field resource", "type": "object", "properties": { "dataType": { "$ref": "#/components/schemas/FieldDataType" }, "fieldName": { "type": "string", "description": "Name of this field." }, "label": { "type": "string", "description": "Label of this field." }, "id": { "type": "string", "description": "Id of this field.", "format": "uuid" }, "localizedValues": { "type": "array", "items": { "$ref": "#/components/schemas/ClassificationListFieldValues" }, "description": "Language specific data of this field." }, "inheritanceState": { "enum": [ "None", "Inherited" ], "type": [ "null", "string" ], "description": "Inheritance State of this field. Opt-in: returned only when requested. Include via a \"select-field: InheritanceState\" header." }, "inheritable": { "type": [ "null", "boolean" ], "description": "Whether the field value can be used as a parent in inheritance hierarchy. Opt-in: returned only when requested. Include via a \"select-field: Inheritable\" header." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" }, "definition": { "description": "Relation to the field definition.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "definition": { "description": "Relation to the field definition. Embed via a \"select-classificationlistfield: definition\" header.", "$ref": "#/components/schemas/FieldDefinitionResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "Representation of a ClassificationListField" }, "ClassificationListFieldValues": { "title": "Classification list field values", "type": "object", "properties": { "values": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Language-specific collection of classification Ids (represented as GUID values)." }, "aIInfluenced": { "type": "boolean", "description": "Flag to indicate whether the value has come from AI." }, "languageId": { "type": "string", "description": "The language id.", "format": "uuid" }, "readOnly": { "type": [ "null", "boolean" ], "description": "Tells if the field is read-only." }, "modifiedOn": { "type": "string", "description": "Contains the date/time when the field is last modified.", "format": "date-time" } }, "description": "The collection of language-specific values stored in the ClassificationList field." }, "ClassificationMaintenanceJobCommand": { "title": "Classification maintenance job command", "type": "object", "properties": { "creatorEmail": { "type": "string", "description": "Email address of the user the job is created on behalf of." }, "disableNotification": { "type": "boolean", "description": "When set to true, suppresses notifications for this job." }, "earliestStartDate": { "type": [ "null", "string" ], "description": "Earliest date and time at which the job is allowed to start executing.", "format": "date-time" }, "priority": { "enum": [ "High", "Medium" ], "type": "string", "description": "Priority used to schedule this job relative to other maintenance jobs." }, "type": { "enum": [ "Classification", "Record", "ExportAuditTrail", "BulkRecord", "AcceptDownloadOrderAgreement", "BulkCollection", "ExportContentItemsList" ], "type": "string", "description": "Type of maintenance job to create." }, "targets": { "type": "array", "items": { "$ref": "#/components/schemas/ClassificationMaintenanceJobTargetModel" }, "description": "Targets the job's actions are applied to." }, "actions": { "type": "array", "items": { "$ref": "#/components/schemas/ActionModel" }, "description": "Actions to execute for each target of this job." }, "title": { "type": "string", "description": "Title of the job. For a download or contact-sheet order this is shown on the Downloads page in Content Workspace; if omitted, it defaults to the file name, or \"X items\" when multiple files were ordered. Either plain text, or a JSON string of the form {\"studioName\":\"...\",\"moduleName\":\"...\",\"translationKey\":\"...\"} to look up a translated value for non-English users (see the Localization > Translations section of the DAM Administrator Guide for how translations are registered)." }, "description": { "type": "string", "description": "Description of the job. For a download or contact-sheet order this is shown on the Downloads page in Content Workspace; if omitted, it defaults to \"Download\". Accepts the same plain-text-or-translation-key JSON format as Title." }, "errorMode": { "type": "string", "description": "Determines how the job behaves when one of its targets fails to execute." } }, "description": "Creates a maintenance job that executes its actions against a classification." }, "ClassificationMaintenanceJobTargetModel": { "title": "Classification maintenance job target model", "type": "object", "properties": { "classificationId": { "type": "string", "description": "Id of the classification this job's actions are applied to.", "format": "uuid" }, "forceRetry": { "type": "boolean", "description": "When set to true, forces this target to be retried even if it previously failed." }, "tag": { "type": "string", "description": "Free-form tag that can be used to identify or group this target." } }, "description": "Target for a classification maintenance job." }, "ClassificationMaintenanceTargetResource": { "title": "Classification maintenance target resource", "type": "object", "properties": { "classificationId": { "type": "string", "description": "The Id of the Classification this target represents.", "format": "uuid" }, "id": { "type": "string", "description": "The Id of this target.", "format": "uuid" }, "attempt": { "type": "integer", "description": "Value indicating how many times the maintenance manager has already tried to execute this target.", "format": "int32" }, "errorDetails": { "type": "string", "description": "Detailed information about the error that occurred if this target failed to execute successfully." }, "executionTime": { "type": "string", "description": "The amount of time needed to execute this target" }, "forceRetry": { "type": "boolean", "description": "Value indicating whether or not a new maintenance job will be created to retry this target after it finished its execution." }, "message": { "type": "string", "description": "The message that was set during the execution of this target" }, "status": { "description": "The status of this target.", "$ref": "#/components/schemas/MaintenanceTargetResourceStatus" }, "tag": { "type": "string", "description": "Custom data associated with this target, if any." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of a classification maintenance target" }, "ClassificationMoveActionParametersModel": { "title": "Classification move action parameters model", "type": "object", "properties": { "parentClassificationId": { "type": "string", "description": "Id of the classification to move the target into.", "format": "uuid" } }, "description": "Parameters for the \"ClassificationMove\" maintenance job action." }, "ClassificationPagedCollectionResource": { "title": "Classification paged collection resource", "type": "object", "properties": { "pageNumber": { "type": [ "null", "integer" ], "description": "The current page of this paged collection.", "format": "int32" }, "pageSize": { "type": [ "null", "integer" ], "description": "The current page size of this paged collection.", "format": "int32" }, "skip": { "type": [ "null", "integer" ], "description": "The current skip size of this paged collection.", "format": "int32" }, "take": { "type": [ "null", "integer" ], "description": "The current take size of this paged collection.", "format": "int32" }, "totalCount": { "type": "integer", "description": "The total count of items in this paged collection, not just on the current page.", "format": "int64" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ClassificationResource" }, "description": "One page of this paged collection, which is a subcollection of the complete collection." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" }, "first": { "description": "A link to the first page of this paged collection.", "$ref": "#/components/schemas/Link" }, "prev": { "description": "A link to the previous page of this paged collection.", "$ref": "#/components/schemas/Link" }, "next": { "description": "A link to the next page of this paged collection.", "$ref": "#/components/schemas/Link" }, "last": { "description": "A link to the last page of this paged collection.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of a paged collection of classifications" }, "ClassificationPermissionsEditCommand": { "title": "Classification permissions edit command", "type": "object", "properties": { "breakInheritance": { "type": "boolean", "description": "When set to true, breaks permission inheritance from the parent classification." }, "permissions": { "$ref": "#/components/schemas/PermissionsModel" } }, "description": "Updates the permissions of a classification." }, "ClassificationPermissionsResource": { "title": "Classification permissions resource", "type": "object", "properties": { "breakInheritance": { "type": "boolean", "description": "Value that indicates whether the record security inheritance chain is broken for the specified classification." }, "permissions": { "type": "array", "items": { "$ref": "#/components/schemas/ClassificationUserGroupPermissionNonResource" }, "description": "List of assigned record permissions per user group for the specified classification." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of a set of permissions linked to a classification" }, "ClassificationResource": { "title": "Classification resource", "type": "object", "properties": { "id": { "type": "string", "description": "Id of this classification.", "format": "uuid" }, "identifier": { "type": "string", "description": "Identifier of this classification." }, "name": { "type": "string", "description": "Name of this classification." }, "namePath": { "type": "string", "description": "Full name path of this classification. Opt-in: returned only when requested. Include via a \"select-classification: NamePath\" header." }, "labelPath": { "type": "string", "description": "Full label path of this classification. Opt-in: returned only when requested. Include via a \"select-classification: LabelPath\" header." }, "labelPaths": { "type": "array", "items": { "$ref": "#/components/schemas/LabelPathNonResource" }, "description": "Full label path of this classification in multiple languages. Opt-in: returned only when requested. Include via a \"select-classification: LabelPaths\" header." }, "sortIndex": { "type": "integer", "description": "Index of this classification. This index indicates where this classification is sorted in the list of children of the parent of this classification.", "format": "int32" }, "sortOrder": { "type": "string", "description": "Get the property used to sort the child classifications of this classification." }, "disabledInDAMUI": { "type": "boolean", "description": "Property used to indicate whether this classification is disabled in DAM UI" }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelNonResource" }, "description": "A collection of Label items." }, "registeredFields": { "type": "array", "items": { "$ref": "#/components/schemas/RegisteredFieldNonResource" }, "description": "A collection of Registered Field items." }, "registeredFieldGroups": { "type": "array", "items": { "$ref": "#/components/schemas/RegisteredFieldGroupNonResource" }, "description": "A collection of Registered Field Group items." }, "isRoot": { "type": "boolean", "description": "Indicates if the classification is a root classification." }, "parentId": { "type": [ "null", "string" ], "description": "Id of the parent of this classification.", "format": "uuid" }, "hasChildren": { "type": [ "null", "boolean" ], "description": "Indicates if the classification has child classifications. Opt-in: returned only when requested. Include via a \"select-classification: HasChildren\" header." }, "tag": { "type": "string", "description": "Value for the Tag of this object. The value of this property has to be valid Xml. Opt-in: returned only when requested. Include via a \"select-classification: Tag\" header." }, "modifiedOn": { "type": "string", "description": "Last modification datetime in UTC time.", "format": "date-time" }, "createdOn": { "type": "string", "description": "Creation datetime in UTC time.", "format": "date-time" }, "_links": { "type": "object", "properties": { "parent": { "description": "Relation to the parent.", "$ref": "#/components/schemas/Link" }, "ancestors": { "description": "Relation to all the ancestors.", "$ref": "#/components/schemas/Link" }, "children": { "description": "Relation to the children.", "$ref": "#/components/schemas/Link" }, "image": { "description": "Relation to a classification image.", "$ref": "#/components/schemas/Link" }, "fields": { "description": "Relation to a collection of fields.", "$ref": "#/components/schemas/Link" }, "recordPermissions": { "description": "Relation to a resource describing the record permissions of the classification.", "$ref": "#/components/schemas/Link" }, "downloadPermissions": { "description": "Relation to a resource describing the classification download permissions of the classification.", "$ref": "#/components/schemas/Link" }, "classificationTreePermissions": { "description": "Relation to a resource describing the classification tree permissions of the classification.", "$ref": "#/components/schemas/Link" }, "followerClassifications": { "description": "Relation to the list of follower classifications of this classification.", "$ref": "#/components/schemas/Link" }, "classificationTreePermission": { "description": "Relation to the permissions.", "$ref": "#/components/schemas/Link" }, "modifiedBy": { "description": "Relation to the user who last modified this classification.", "$ref": "#/components/schemas/Link" }, "createdBy": { "description": "Relation to the user who created this classification.", "$ref": "#/components/schemas/Link" }, "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "parent": { "description": "Relation to the parent. Embed via a \"select-classification: parent\" header.", "$ref": "#/components/schemas/ClassificationResource" }, "ancestors": { "description": "Relation to all the ancestors. Embed via a \"select-classification: ancestors\" header.", "$ref": "#/components/schemas/LinkedClassificationCollectionResource" }, "children": { "description": "Relation to the children. Embed via a \"select-classification: children\" header.", "$ref": "#/components/schemas/ClassificationCollectionResource" }, "image": { "description": "Relation to a classification image. Embed via a \"select-classification: image\" header.", "$ref": "#/components/schemas/ImageResource" }, "fields": { "description": "Relation to a collection of fields. Embed via a \"select-classification: fields\" header.", "$ref": "#/components/schemas/FieldCollectionResource" }, "recordPermissions": { "description": "Relation to a resource describing the record permissions of the classification. Embed via a \"select-classification: recordPermissions\" header.", "$ref": "#/components/schemas/ClassificationPermissionsResource" }, "downloadPermissions": { "description": "Relation to a resource describing the classification download permissions of the classification. Embed via a \"select-classification: downloadPermissions\" header.", "$ref": "#/components/schemas/ClassificationDownloadPermissionsResource" }, "classificationTreePermissions": { "description": "Relation to a resource describing the classification tree permissions of the classification. Embed via a \"select-classification: classificationTreePermissions\" header.", "$ref": "#/components/schemas/ClassificationPermissionsResource" }, "followerClassifications": { "description": "Relation to the list of follower classifications of this classification. Embed via a \"select-classification: followerClassifications\" header.", "$ref": "#/components/schemas/ClassificationCollectionResource" }, "classificationTreePermission": { "description": "Relation to the permissions. Embed via a \"select-classification: classificationTreePermission\" header.", "$ref": "#/components/schemas/ClassificationUserPermissionsResource" }, "modifiedBy": { "description": "Relation to the user who last modified this classification. Embed via a \"select-classification: modifiedBy\" header.", "$ref": "#/components/schemas/UserResource" }, "createdBy": { "description": "Relation to the user who created this classification. Embed via a \"select-classification: createdBy\" header.", "$ref": "#/components/schemas/UserResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "A node in the hierarchical taxonomy used to categorize records. Records are classified by linking them to one or more classifications; field definitions, permissions, and download restrictions can be attached at any node and are inherited by its descendants." }, "ClassificationRight": { "title": "Classification right", "enum": [ "NoAccess", "Read", "Classify", "Modify", "Delete", "FullControl", "DeleteDenyFullControl", "ModifyDenyDelete", "ClassifyDenyModify", "ReadDenyClassify", "DenyRead", "Inherit" ], "type": "string" }, "ClassificationSearchModel": { "title": "Classification search model", "type": "object", "properties": { "searchExpression": { "description": "Search expression used to filter classifications.", "$ref": "#/components/schemas/SearchExpressionModel" }, "logRequest": { "type": "boolean", "description": "Value indicating whether this request should be logged." }, "userQuery": { "type": [ "null", "boolean" ], "description": "Value indicating whether this is a user-initiated query." } }, "description": "Represents a request to search classifications." }, "ClassificationUnlinkedRuleConditionModel": { "title": "Classification unlinked rule condition model", "type": "object", "properties": { "directLinkOnly": { "type": "boolean", "description": "If true, only a direct link is considered" }, "classificationId": { "type": "string", "description": "Id of the classification to check", "format": "uuid" }, "index": { "type": "integer", "description": "Index of the condition within the rule's condition collection", "format": "int32" }, "conditionType": { "description": "Type of condition to be evaluated.", "$ref": "#/components/schemas/RuleConditionDataType" } }, "description": "Model for ClassificationUnlinked rule condition" }, "ClassificationUnlinkedRuleConditionNonResource": { "title": "Classification unlinked rule condition non resource", "type": "object", "properties": { "classificationId": { "type": "string", "description": "Classification id", "format": "uuid" }, "directLinkOnly": { "type": "boolean", "description": "Specifies whether is directly linked or not" }, "index": { "type": "integer", "description": "Index of a rule condition in collection", "format": "int32" }, "conditionType": { "description": "Data type of this rule condition", "$ref": "#/components/schemas/RuleConditionDataType" } }, "description": "Representation of Classification unlinked rule" }, "ClassificationUserGroupDownloadPermissionNonResource": { "title": "Classification user group download permission non resource", "type": "object", "properties": { "userGroupId": { "type": "string", "description": "Id of the user group this permission applies to", "format": "uuid" }, "accessRight": { "description": "Download rights of this permission", "$ref": "#/components/schemas/DownloadRight" } }, "description": "Representation of the classification download rights for a user group." }, "ClassificationUserGroupPermissionNonResource": { "title": "Classification user group permission non resource", "type": "object", "properties": { "userGroupId": { "type": "string", "description": "Id of the user group this permission applies too", "format": "uuid" }, "accessRight": { "description": "Access right of this permission", "$ref": "#/components/schemas/ClassificationRight" } }, "description": "Representation of a classification access right for a user group. The following rights you can only apply to classification tree: classifydenymodify, readdenyclassify, classify." }, "ClassificationUserPermissionsResource": { "title": "Classification user permissions resource", "type": "object", "properties": { "canRead": { "type": "boolean", "description": "Indicates whether the current user has read permissions on this object." }, "canClassify": { "type": "boolean", "description": "Indicates whether the current user has classify permissions on this object." }, "canModify": { "type": "boolean", "description": "Indicates whether the current user has modify permissions on this object." }, "canDelete": { "type": "boolean", "description": "Indicates whether the current user has delete permissions on this object." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of the permissions on a classification" }, "ClassifiedInConditionModel": { "title": "Classified in condition model", "type": "object", "properties": { "classificationIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "The classification ID" }, "directLinkOnly": { "type": "boolean", "description": "Whether to only check direct links (not inherited)" }, "conditionType": { "description": "The type of condition. Determines which additional properties apply.", "$ref": "#/components/schemas/FileProcessConditionDataType" } }, "description": "Model for ClassifiedIn condition - checks if the record is classified in a specific classification" }, "ClassifiedInRuleConditionModel": { "title": "Classified in rule condition model", "type": "object", "properties": { "directLinkOnly": { "type": "boolean", "description": "If true, only a direct link is considered" }, "classificationId": { "type": "string", "description": "Id of the classification to check", "format": "uuid" }, "index": { "type": "integer", "description": "Index of the condition within the rule's condition collection", "format": "int32" }, "conditionType": { "description": "Type of condition to be evaluated.", "$ref": "#/components/schemas/RuleConditionDataType" } }, "description": "Model for ClassifiedIn rule condition" }, "ClassifiedInRuleConditionNonResource": { "title": "Classified in rule condition non resource", "type": "object", "properties": { "classificationId": { "type": "string", "description": "Classification id", "format": "uuid" }, "directLinkOnly": { "type": "boolean", "description": "Specifies whether is directly linked or not" }, "index": { "type": "integer", "description": "Index of a rule condition in collection", "format": "int32" }, "conditionType": { "description": "Data type of this rule condition", "$ref": "#/components/schemas/RuleConditionDataType" } }, "description": "Representation of Classified In rule" }, "ClassifyRecordActionParametersModel": { "title": "Classify record action parameters model", "type": "object", "properties": { "classificationId": { "type": "string", "description": "Id of the classification to add to the record.", "format": "uuid" } }, "description": "Parameters for the \"ClassifyRecord\" maintenance job action." }, "ClassifyRecordRuleActionModel": { "title": "Classify record rule action model", "type": "object", "properties": { "reference": { "type": "string", "description": "A dynamic-value expression that resolves to a classification id or name path (depending on identifierType), used when gettingType is CalculatedByReference." }, "gettingType": { "description": "Controls how the classification is specified: either with a specific id (Specified) or as the result of a reference (CalculatedByReference). See ClassificationGettingType.", "$ref": "#/components/schemas/ClassificationGettingType" }, "identifierType": { "description": "What reference resolves to when gettingType is CalculatedByReference: an id or a name path. See ClassificationIdentifierType.", "$ref": "#/components/schemas/ClassificationIdentifierType" }, "classificationId": { "type": [ "null", "string" ], "description": "Id of the classification, used when gettingType is Specified.", "format": "uuid" }, "index": { "type": "integer", "description": "Index of the action within the rule's action collection", "format": "int32" }, "actionType": { "description": "Type of action to be executed.", "$ref": "#/components/schemas/RuleActionDataType" }, "executionTime": { "description": "When the action should be executed.", "$ref": "#/components/schemas/RuleExecutionTime" } } }, "ClassifyRecordRuleActionNonResource": { "title": "Classify record rule action non resource", "type": "object", "properties": { "reference": { "type": "string", "description": "A reference that results in a classification Id or name path, depending on the value of IdentifierType." }, "gettingType": { "description": "Controls how the classification is specified: either with a specific Id (Specified) or as a result of a reference (CalculatedByReference).", "$ref": "#/components/schemas/ClassificationGettingType" }, "identifierType": { "description": "Specify what is given as identification for the classification, in case GettingType is set to \"CalculatedByReference\". Possible values are Identifier or NamePath.", "$ref": "#/components/schemas/ClassificationIdentifierType" }, "classificationId": { "type": [ "null", "string" ], "description": "Specify the Id of the classification, in case GettingType is set to \"Specified\".", "format": "uuid" }, "index": { "type": "integer", "description": "Index of a rule action in collection", "format": "int32" }, "actionType": { "description": "Data type of this rule action", "$ref": "#/components/schemas/RuleActionDataType" }, "executionTime": { "description": "Execution time of the rule action", "$ref": "#/components/schemas/RuleExecutionTime" } }, "description": "Link target with the classification." }, "CollectionCommentCreateCommand": { "title": "Collection comment create command", "type": "object", "properties": { "message": { "type": "string", "description": "Text of the comment." } }, "description": "Creates a new comment on a collection." }, "CollectionCommentEditCommand": { "title": "Collection comment edit command", "type": "object", "properties": { "content": { "type": "string", "description": "New text of the comment." } }, "description": "Updates the content of an existing comment on a collection." }, "CollectionContentPermissionNonResource": { "title": "Collection content permission non resource", "type": "object", "properties": { "contentSharingEnabled": { "type": "boolean", "description": "Boolean value indicating whether content sharing is enabled." }, "contentSharingExpiryDate": { "type": [ "null", "string" ], "description": "Datetime value in UTC indicating whether content sharing options are still active.", "format": "date-time" }, "permission": { "enum": [ "None", "Read", "Modify" ], "type": [ "null", "string" ], "description": "Permission for the collection content sharing." } }, "description": "Representation of collection content sharing for a collection." }, "CollectionCreateCommandBase": { "title": "Collection create command base", "type": "object", "properties": { "type": { "description": "Type of the collection, static or dynamic.", "$ref": "#/components/schemas/CollectionsCollectionType" }, "searchAllLanguages": { "type": "boolean", "description": "When set to true, the collection's search expression matches records in all languages." }, "tag": { "type": "string", "description": "Tag for the collection." }, "name": { "type": "string", "description": "Name of the collection." }, "description": { "type": "string", "description": "Description of the collection." }, "searchExpression": { "description": "Search expression that determines the contents of a dynamic collection.", "$ref": "#/components/schemas/CollectionsSearchExpressionModel" }, "searchCriteria": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Legacy, untyped alternative to \"searchExpression\" for defining a dynamic collection's contents; kept for backward compatibility with collections created before \"searchExpression\" existed. Its shape is not documented or validated. Prefer \"searchExpression\" for new collections." }, "allowAutoAccess": { "type": "boolean", "description": "Whether non-members can be granted view access via PUT /collection/:id/permissions/autoReadAccess. Silently ignored (forced false) for dynamic collections. Rejected with a validation error if set to true while the auto-access feature toggle is disabled for the tenant." } }, "description": "Creates a new collection." }, "CollectionEditCommandBase": { "title": "Collection edit command base", "type": "object", "properties": { "searchAllLanguages": { "type": "boolean", "description": "When set to true, the collection's search expression matches records in all languages." }, "status": { "enum": [ "Active", "Archived", "Deleted" ], "type": "string", "description": "When set, updates lifecycle status using the same values as CollectionStatus. Deleted is not allowed; use DELETE to remove a collection." }, "tag": { "type": "string", "description": "Tag for the collection." }, "name": { "type": "string", "description": "Name of the collection." }, "description": { "type": "string", "description": "Description of the collection." }, "searchExpression": { "description": "Search expression that determines the contents of a dynamic collection.", "$ref": "#/components/schemas/CollectionsSearchExpressionModel" }, "searchCriteria": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Legacy, untyped alternative to \"searchExpression\" for defining a dynamic collection's contents; kept for backward compatibility with collections created before \"searchExpression\" existed. Its shape is not documented or validated. Prefer \"searchExpression\" for new collections." }, "allowAutoAccess": { "type": "boolean", "description": "Whether non-members can be granted view access via PUT /collection/:id/permissions/autoReadAccess. Silently ignored (forced false) for dynamic collections. Rejected with a validation error if set to true while the auto-access feature toggle is disabled for the tenant." } }, "description": "Updates an existing collection." }, "CollectionGroupPermissionNonResource": { "title": "Collection group permission non resource", "type": "object", "properties": { "groupId": { "type": "string", "description": "Id of the user group this permission applies to", "format": "uuid" }, "permission": { "description": "Permissions", "$ref": "#/components/schemas/CollectionPermission" } }, "description": "Representation of a collection permission for a user group." }, "CollectionPagedCollectionResource": { "title": "Collection paged collection resource", "type": "object", "properties": { "pageNumber": { "type": [ "null", "integer" ], "description": "The current page of this paged collection.", "format": "int32" }, "pageSize": { "type": [ "null", "integer" ], "description": "The current page size of this paged collection.", "format": "int32" }, "skip": { "type": [ "null", "integer" ], "description": "The current skip size of this paged collection.", "format": "int32" }, "take": { "type": [ "null", "integer" ], "description": "The current take size of this paged collection.", "format": "int32" }, "totalCount": { "type": "integer", "description": "The total count of items in this paged collection, not just on the current page.", "format": "int64" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/CollectionResource" }, "description": "One page of this paged collection, which is a subcollection of the complete collection." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" }, "first": { "description": "A link to the first page of this paged collection.", "$ref": "#/components/schemas/Link" }, "prev": { "description": "A link to the previous page of this paged collection.", "$ref": "#/components/schemas/Link" }, "next": { "description": "A link to the next page of this paged collection.", "$ref": "#/components/schemas/Link" }, "last": { "description": "A link to the last page of this paged collection.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of a paged collection of collections" }, "CollectionPermission": { "title": "Collection permission", "enum": [ "None", "Read", "Modify" ], "type": "string" }, "CollectionPermissionsAutoReadAccessCommand": { "title": "Collection permissions auto read access command", "type": "object", "properties": { "userIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "The users to grant Read access to." }, "requestingUserId": { "type": [ "null", "string" ], "description": "Optional DAM user GUID of the user who triggered the auto-grant when the REST session uses elevated credentials (e.g. MO API calls the endpoint with elevated rights).", "format": "uuid" } }, "description": "Command to grant Read access to a set of users on a collection, gated by the collection's AllowAutoAccess setting and filtered against existing explicit permissions." }, "CollectionPermissionsAutoReadAccessResource": { "title": "Collection permissions auto read access resource", "type": "object", "properties": { "autoAccessEnabled": { "type": "boolean", "description": "Whether the collection allows auto-access (the gate the caller must open via AllowAutoAccess)." }, "grantedUserIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "The userIds that received an explicit Read grant as a result of this request. Null when the feature flag is OFF; otherwise an array (empty or populated)." }, "skippedUserIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "On the toggle-OFF path (flag ON), the requested users who still lack effective access. Null when the feature flag is OFF; empty array on the grant path and when all tagged users have access." } }, "description": "Representation of the outcome of an auto-access permissions request on a collection." }, "CollectionPermissionsEditCommand": { "title": "Collection permissions edit command", "type": "object", "properties": { "collectionOwnerId": { "type": "string", "description": "Identifier of the user who owns the collection.", "format": "uuid" }, "permissions": { "$ref": "#/components/schemas/CollectionsPermissionsModel" }, "groupsPermissions": { "$ref": "#/components/schemas/GroupPermissionsModel" }, "publicPermission": { "enum": [ "None", "Read", "Modify" ], "type": [ "null", "string" ], "description": "Permission granted to all users who do not have an explicit or group-based permission. Only None and Read are accepted; specifying Modify returns a 400 validation error." }, "contentPermission": { "description": "Content sharing permissions for the collection.", "$ref": "#/components/schemas/ContentPermissionsModel" } }, "description": "Updates the permissions of a collection." }, "CollectionPermissionsResource": { "title": "Collection permissions resource", "type": "object", "properties": { "permissions": { "type": "array", "items": { "$ref": "#/components/schemas/CollectionUserPermissionNonResource" }, "description": "List of assigned permissions per user for the specified collection." }, "groupsPermissions": { "type": "array", "items": { "$ref": "#/components/schemas/CollectionGroupPermissionNonResource" }, "description": "List of assigned permissions per user group for the specified collection." }, "publicPermission": { "description": "Public permission for the specified collection.", "$ref": "#/components/schemas/CollectionPublicPermission" }, "canRead": { "type": "boolean", "description": "Indicates whether the current user has read permissions on this object." }, "canModify": { "type": "boolean", "description": "Indicates whether the current user has modify permissions on this object." }, "contentPermission": { "description": "Permission for the collection content sharing.", "$ref": "#/components/schemas/CollectionContentPermissionNonResource" }, "_links": { "type": "object", "properties": { "self": { "description": "Link to the current resource", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of a set of permissions of the collection" }, "CollectionPublicPermission": { "title": "Collection public permission", "enum": [ "None", "Read" ], "type": "string" }, "CollectionRecordsEditCommand": { "title": "Collection records edit command", "type": "object", "properties": { "records": { "description": "Records to add or remove from the collection.", "$ref": "#/components/schemas/EditableIdCollectionModel" } }, "description": "Updates the records contained in a static collection." }, "CollectionResource": { "title": "Collection resource", "type": "object", "properties": { "id": { "type": "string", "description": "Id of this collection.", "format": "uuid" }, "name": { "type": "string", "description": "Name of this collection." }, "description": { "type": "string", "description": "Description of this collection." }, "type": { "description": "Type of this collection (static or dynamic).", "$ref": "#/components/schemas/CollectionType" }, "status": { "description": "Lifecycle status of this collection (active, archived, or deleted).", "$ref": "#/components/schemas/CollectionResourceStatus" }, "searchExpression": { "description": "Search expression of this collection. Returns null when the collection is static.", "$ref": "#/components/schemas/SearchExpressionModel" }, "searchCriteria": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Legacy, untyped alternative to \"searchExpression\", present only when the collection was created or last edited using it instead. Returns null for static collections and for dynamic collections defined via \"searchExpression\"." }, "ownerId": { "type": "string", "description": "Collection owner Id.", "format": "uuid" }, "tag": { "type": "string", "description": "Value for the Tag of this object. The value of this property has to be valid Xml. Opt-in: returned only when requested. Include via a \"select-collection: Tag\" header." }, "isReadOnly": { "type": [ "null", "boolean" ], "description": "Value indicating whether the collection is read-only for current user. Opt-in: returned only when requested. Include via a \"select-collection: IsReadOnly\" header." }, "allowAutoAccess": { "type": [ "null", "boolean" ], "description": "Value indicating whether non-members can be granted view access through PUT /collection/:id/permissions/autoReadAccess. Opt-in: returned only when requested. Include via a \"select-collection: AllowAutoAccess\" header." }, "modifiedOn": { "type": "string", "description": "Last modification datetime in UTC time.", "format": "date-time" }, "createdOn": { "type": "string", "description": "Creation datetime in UTC time.", "format": "date-time" }, "_links": { "type": "object", "properties": { "ownedBy": { "description": "Relation to the user who owns the collection.", "$ref": "#/components/schemas/Link" }, "permissions": { "description": "Relation to the per user permissions of the collection.", "$ref": "#/components/schemas/Link" }, "records": { "description": "Relation to the list of records of the collection.", "$ref": "#/components/schemas/Link" }, "comments": { "description": "Relation to the list of comments on the collection.", "$ref": "#/components/schemas/Link" }, "modifiedBy": { "description": "Relation to the user who last modified the collection.", "$ref": "#/components/schemas/Link" }, "createdBy": { "description": "Relation to the user who created the collection.", "$ref": "#/components/schemas/Link" }, "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "ownedBy": { "description": "Relation to the user who owns the collection. Embed via a \"select-collection: ownedBy\" header.", "$ref": "#/components/schemas/UserResource" }, "permissions": { "description": "Relation to the per user permissions of the collection. Embed via a \"select-collection: permissions\" header.", "$ref": "#/components/schemas/CollectionPermissionsResource" }, "records": { "description": "Relation to the list of records of the collection. Embed via a \"select-collection: records\" header.", "$ref": "#/components/schemas/RecordCollectionResource" }, "comments": { "description": "Relation to the list of comments on the collection. Embed via a \"select-collection: comments\" header.", "$ref": "#/components/schemas/CommentPagedCollectionResource" }, "modifiedBy": { "description": "Relation to the user who last modified the collection. Embed via a \"select-collection: modifiedBy\" header.", "$ref": "#/components/schemas/UserResource" }, "createdBy": { "description": "Relation to the user who created the collection. Embed via a \"select-collection: createdBy\" header.", "$ref": "#/components/schemas/UserResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "A user-curated, named group of records that can be shared, commented on, and populated either by explicitly adding records or by saved search criteria - independent of the classification tree." }, "CollectionResourceStatus": { "title": "Collection resource status", "enum": [ "Active", "Archived", "Deleted" ], "type": "string" }, "CollectionSearchBodyResource": { "title": "Collection search body resource", "type": "object", "properties": { "includeArchived": { "type": "boolean", "description": "Value indicating whether archived collections are included in the results." }, "filter": { "type": "string" }, "sort": { "type": "string" }, "skip": { "type": "integer", "format": "int32" }, "take": { "type": "integer", "format": "int32" } }, "description": "Request body for the collections search endpoint." }, "CollectionType": { "title": "Collection type", "enum": [ "Static", "Dynamic" ], "type": "string" }, "CollectionUserPermissionNonResource": { "title": "Collection user permission non resource", "type": "object", "properties": { "userId": { "type": "string", "description": "Id of the user this permission applies to", "format": "uuid" }, "permission": { "description": "Permissions", "$ref": "#/components/schemas/CollectionPermission" } }, "description": "Representation of a collection permission for a user." }, "CollectionsCollectionType": { "title": "Collections collection type", "enum": [ "Static", "Dynamic" ], "type": "string", "x-enum-descriptions": [ "Collection whose records are explicitly added and removed.", "Collection whose records are determined by a search expression." ] }, "CollectionsPermissionModel": { "title": "Collections permission model", "type": "object", "properties": { "userId": { "type": [ "null", "string" ], "description": "Identifier of the user this permission applies to.", "format": "uuid" }, "permission": { "enum": [ "None", "Read", "Modify" ], "type": [ "null", "string" ], "description": "Permission granted to the user." }, "id": { "type": "string", "description": "Identifier used to match this entry, equal to UserId.", "format": "uuid" } }, "description": "Permission granted to a user on a collection." }, "CollectionsPermissionsModel": { "title": "Collections permissions model", "type": "object", "properties": { "addOrUpdate": { "type": "array", "items": { "$ref": "#/components/schemas/CollectionsPermissionModel" }, "description": "User permissions to add or update." }, "remove": { "type": "array", "items": { "$ref": "#/components/schemas/CollectionsPermissionModel" }, "description": "User permissions to remove." } }, "description": "Collection of user permissions to add, update, or remove." }, "CollectionsSearchExpressionModel": { "title": "Collections search expression model", "type": "object", "properties": { "languages": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Languages the search expression applies to." }, "expression": { "type": "string", "description": "Search expression text." }, "subExpressions": { "type": "array", "items": { "$ref": "#/components/schemas/CollectionsSearchExpressionModel" }, "description": "Sub-expressions combined to form this search expression." }, "parameters": { "type": "array", "items": { "type": "string" }, "description": "Positional parameters used by the search expression." }, "namedParameters": { "type": "array", "items": { "type": "string" }, "description": "Named parameters used by the search expression." } }, "description": "Search expression used to determine the contents of a dynamic collection." }, "ColorSpace": { "title": "Color space", "enum": [ "Unknown", "Rgb", "Cmyk", "Lab", "IndexedColor", "GrayScale", "Bitmap", "KeepOriginal" ], "type": "string", "x-enum-descriptions": [ "Unknown color space.", "RGB color space.", "CMYK color space.", "LAB color space.", "Indexed color with 8 bits per pixel.", "Gray scale color space.", "Bitmap color space.", "Keep original color space." ] }, "CommentPagedCollectionResource": { "title": "Comment paged collection resource", "type": "object", "properties": { "pageNumber": { "type": [ "null", "integer" ], "description": "The current page of this paged collection.", "format": "int32" }, "pageSize": { "type": [ "null", "integer" ], "description": "The current page size of this paged collection.", "format": "int32" }, "skip": { "type": [ "null", "integer" ], "description": "The current skip size of this paged collection.", "format": "int32" }, "take": { "type": [ "null", "integer" ], "description": "The current take size of this paged collection.", "format": "int32" }, "totalCount": { "type": "integer", "description": "The total count of items in this paged collection, not just on the current page.", "format": "int64" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/CommentResource" }, "description": "One page of this paged collection, which is a subcollection of the complete collection." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" }, "first": { "description": "A link to the first page of this paged collection.", "$ref": "#/components/schemas/Link" }, "prev": { "description": "A link to the previous page of this paged collection.", "$ref": "#/components/schemas/Link" }, "next": { "description": "A link to the next page of this paged collection.", "$ref": "#/components/schemas/Link" }, "last": { "description": "A link to the last page of this paged collection.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of a non-paged collection of comments" }, "CommentResource": { "title": "Comment resource", "type": "object", "properties": { "id": { "type": "string", "description": "Id of this comment.", "format": "uuid" }, "contextId": { "type": [ "null", "integer" ], "description": "Context id of this comment.", "format": "int64" }, "message": { "type": "string", "description": "Message of this comment." }, "read": { "type": [ "null", "boolean" ], "description": "Determines if this comment has been read (by the current user) or not. Opt-in: returned only when requested. Include via a \"select-comment: Read\" header." }, "tag": { "type": "string", "description": "Value for the Tag of this object. The value of this property should be valid Xml. Opt-in: returned only when requested. Include via a \"select-comment: Tag\" header." }, "version": { "type": [ "null", "integer" ], "description": "Version number of the comment (number of edits).", "format": "int32" }, "modifiedOn": { "type": "string", "description": "Last modification datetime in UTC time.", "format": "date-time" }, "createdOn": { "type": "string", "description": "Creation datetime in UTC time.", "format": "date-time" }, "_links": { "type": "object", "properties": { "modifiedBy": { "description": "Relation to the user who last modified this record.", "$ref": "#/components/schemas/Link" }, "createdBy": { "description": "Relation to the user who created this record.", "$ref": "#/components/schemas/Link" }, "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "modifiedBy": { "description": "Relation to the user who last modified this record. Embed via a \"select-comment: modifiedBy\" header.", "$ref": "#/components/schemas/UserResource" }, "createdBy": { "description": "Relation to the user who created this record. Embed via a \"select-comment: createdBy\" header.", "$ref": "#/components/schemas/UserResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "Representation of a comment." }, "CommentsStatusResource": { "title": "Comments status resource", "type": "object", "properties": { "unreadComments": { "type": "integer", "description": "Number of unread comments in the collection.", "format": "int32" } }, "description": "Representation of the status of comments in a collection." }, "CompareFieldValueConditionModel": { "title": "Compare field value condition model", "type": "object", "properties": { "fieldValue": { "description": "The field comparison to evaluate.", "$ref": "#/components/schemas/FieldValueConditionMapping" }, "conditionType": { "description": "The type of condition. Determines which additional properties apply.", "$ref": "#/components/schemas/FileProcessConditionDataType" } }, "description": "Model for CompareFieldValue condition - evaluates a field comparison expression" }, "CompareFieldValueRuleConditionModel": { "title": "Compare field value rule condition model", "type": "object", "properties": { "expression": { "type": "string", "description": "Expression used to compare the field value" }, "index": { "type": "integer", "description": "Index of the condition within the rule's condition collection", "format": "int32" }, "conditionType": { "description": "Type of condition to be evaluated.", "$ref": "#/components/schemas/RuleConditionDataType" } }, "description": "Model for CompareFieldValue rule condition" }, "CompareFieldValueRuleConditionNonResource": { "title": "Compare field value rule condition non resource", "type": "object", "properties": { "expression": { "type": "string", "description": "Compare expression to apply" }, "index": { "type": "integer", "description": "Index of a rule condition in collection", "format": "int32" }, "conditionType": { "description": "Data type of this rule condition", "$ref": "#/components/schemas/RuleConditionDataType" } }, "description": "Representation of the Compare Field Value rule condition, which evaluates a compare expression against field values." }, "ContentItemScanResult": { "title": "Content item scan result", "type": "object", "properties": { "phrase": { "type": "string", "description": "Phrase that was flagged by the scan." }, "concern": { "type": "string", "description": "Concern identified for the phrase." }, "recommendation": { "type": "string", "description": "Recommendation for addressing the concern." } }, "description": "A single finding produced by a smart-action content scan." }, "ContentPermissionsModel": { "title": "Content permissions model", "type": "object", "properties": { "contentSharingEnabled": { "type": [ "null", "boolean" ], "description": "Whether content sharing is enabled for the collection." }, "contentSharingExpiryDate": { "type": [ "null", "string" ], "description": "Date and time after which content sharing expires.", "format": "date-time" }, "permission": { "enum": [ "None", "Read", "Modify" ], "type": [ "null", "string" ], "description": "Permission granted to shared content viewers." } }, "description": "Content sharing permission settings for a collection." }, "ContentTypeChangedRuleConditionModel": { "title": "Content type changed rule condition model", "type": "object", "properties": { "index": { "type": "integer", "description": "Index of the condition within the rule's condition collection", "format": "int32" }, "conditionType": { "description": "Type of condition to be evaluated.", "$ref": "#/components/schemas/RuleConditionDataType" } }, "description": "Model for ContentTypeChanged rule condition" }, "ContentTypeChangedRuleConditionNonResource": { "title": "Content type changed rule condition non resource", "type": "object", "properties": { "index": { "type": "integer", "description": "Index of a rule condition in collection", "format": "int32" }, "conditionType": { "description": "Data type of this rule condition", "$ref": "#/components/schemas/RuleConditionDataType" } }, "description": "Representation of the Content Type Changed rule condition, which matches when the record's content type has changed." }, "ContentTypeChangedToRuleConditionModel": { "title": "Content type changed to rule condition model", "type": "object", "properties": { "directLinkOnly": { "type": "boolean", "description": "If true, only a direct link is considered" }, "contentType": { "type": "string", "description": "Content type name" }, "index": { "type": "integer", "description": "Index of the condition within the rule's condition collection", "format": "int32" }, "conditionType": { "description": "Type of condition to be evaluated.", "$ref": "#/components/schemas/RuleConditionDataType" } }, "description": "Model for ContentTypeSetTo rule condition" }, "ContentTypeChangedToRuleConditionNonResource": { "title": "Content type changed to rule condition non resource", "type": "object", "properties": { "contentType": { "type": "string", "description": "ContentType Name" }, "directLinkOnly": { "type": "boolean", "description": "Specifies whether is directly linked or not" }, "index": { "type": "integer", "description": "Index of a rule condition in collection", "format": "int32" }, "conditionType": { "description": "Data type of this rule condition", "$ref": "#/components/schemas/RuleConditionDataType" } }, "description": "Representation of the Content Type Changed To rule condition, which matches when the record's content type is changed to the specified value." }, "ContentTypeCreateCommand": { "title": "Content type create command", "type": "object", "properties": { "name": { "type": "string", "description": "Name of the content type." }, "purpose": { "type": "string", "description": "Purpose of the content type." }, "parentId": { "type": [ "null", "string" ], "description": "Id of the parent content type this content type inherits from.", "format": "uuid" }, "titleConfiguration": { "description": "Configuration that determines how the title of a record of this content type is resolved.", "$ref": "#/components/schemas/TitleConfigurationModel" }, "registeredFields": { "description": "Fields registered on this content type. Use AddOrUpdate to add or update members, or Remove to remove them.", "$ref": "#/components/schemas/EditableIdCollectionModel" }, "registeredFieldGroups": { "description": "Field groups registered on this content type. Use AddOrUpdate to add or update members, or Remove to remove them.", "$ref": "#/components/schemas/EditableIdCollectionModel" }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelModel" }, "description": "Multi-language labels for the name of this content type." }, "defaultFileExtensions": { "description": "Default file extensions associated with this content type. Use AddOrUpdate to add or update members, or Remove to remove them.", "$ref": "#/components/schemas/EditableStringIdCollectionModel" }, "inheritanceConfiguration": { "enum": [ "None", "Parent", "Custom" ], "type": "string", "description": "Configuration that determines which fields are inherited from the parent content type." }, "inheritanceFieldId": { "type": [ "null", "string" ], "description": "Id of the field used to resolve the parent record for inheritance.", "format": "uuid" }, "inheritableFields": { "description": "Fields that can be inherited from the parent content type. Use AddOrUpdate to add or update members, or Remove to remove them.", "$ref": "#/components/schemas/EditableIdCollectionModel" }, "isNoFile": { "type": [ "null", "boolean" ], "description": "When set to true, records of this content type do not have a file." }, "fileMode": { "type": "string", "description": "File mode of the content type." }, "fileConfiguration": { "description": "File-related configuration for this content type.", "$ref": "#/components/schemas/FileConfigurationModel" } }, "description": "Command to create a new content type." }, "ContentTypeCreatedResource": { "title": "Content type created resource", "type": "object", "properties": { "id": { "type": "string", "description": "The Id of the created content type", "format": "uuid" } }, "description": "Represents the newly created content type" }, "ContentTypeEditCommand": { "title": "Content type edit command", "type": "object", "properties": { "name": { "type": "string", "description": "Name of the content type." }, "purpose": { "type": "string", "description": "Purpose of the content type." }, "parentId": { "type": [ "null", "string" ], "description": "Id of the parent content type this content type inherits from.", "format": "uuid" }, "titleConfiguration": { "description": "Configuration that determines how the title of a record of this content type is resolved.", "$ref": "#/components/schemas/TitleConfigurationModel" }, "registeredFields": { "description": "Fields registered on this content type. Use AddOrUpdate to add or update members, or Remove to remove them.", "$ref": "#/components/schemas/EditableIdCollectionModel" }, "registeredFieldGroups": { "description": "Field groups registered on this content type. Use AddOrUpdate to add or update members, or Remove to remove them.", "$ref": "#/components/schemas/EditableIdCollectionModel" }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelModel" }, "description": "Multi-language labels for the name of this content type." }, "defaultFileExtensions": { "description": "Default file extensions associated with this content type. Use AddOrUpdate to add or update members, or Remove to remove them.", "$ref": "#/components/schemas/EditableStringIdCollectionModel" }, "inheritanceConfiguration": { "enum": [ "None", "Parent", "Custom" ], "type": "string", "description": "Configuration that determines which fields are inherited from the parent content type." }, "inheritanceFieldId": { "type": [ "null", "string" ], "description": "Id of the field used to resolve the parent record for inheritance.", "format": "uuid" }, "inheritableFields": { "description": "Fields that can be inherited from the parent content type. Use AddOrUpdate to add or update members, or Remove to remove them.", "$ref": "#/components/schemas/EditableIdCollectionModel" }, "isNoFile": { "type": [ "null", "boolean" ], "description": "When set to true, records of this content type do not have a file." }, "fileMode": { "type": "string", "description": "File mode of the content type." }, "fileConfiguration": { "description": "File-related configuration for this content type.", "$ref": "#/components/schemas/FileConfigurationModel" } }, "description": "Command to update an existing content type." }, "ContentTypeFacetModel": { "title": "Content type facet model", "type": "object", "properties": { "rootContentType": { "type": "string", "description": "Specify the content type to be used as the root. All child content types are returned, including the root content type itself." }, "directLinkedOnly": { "type": [ "null", "boolean" ], "description": "Determines if facet counts only take records into account that are directly linked to the facet content type, or also records linked to child content types." }, "maximumFacetValues": { "type": [ "null", "integer" ], "description": "Maximum number of facet values returned.", "format": "int32" }, "filters": { "type": "array", "items": { "type": "string" }, "description": "Filters allow you to limit the hits returned without affecting facets. If filters are specified, the aggregated counts in the facets remain the same. However, only records that match the filter criteria specified in the facet are returned. The parameter type of the filters depends on the facet type, but is always the same type as explicitValues/explicitRanges." }, "explicitValues": { "type": "array", "items": { "type": "string" }, "description": "A list of values. When specified, only shows facets corresponding to the specified values. If not specified, all occurring values are included." }, "explicitRanges": { "type": "array", "items": { "type": "string" }, "description": "Allows for the explicit specification of ranges to include in the facet. If explicitRanges is specified, you cannot specify rangeStart, rangeEnd, or spans (on the concrete range facet type)." }, "name": { "type": "string", "description": "A textual identifier for this facet, used only by the client to correlate requests with responses." }, "type": { "enum": [ "NumericField", "NumericFieldRange", "Classification", "CreatedBy", "ModifiedBy", "FileType", "OptionListField", "TextField", "DateTimeFieldRange", "DateFieldRange", "CreatedOn", "ModifiedOn", "TimeFieldRange", "TextListField", "ContentType", "ClassificationListField", "DateFieldRangeFilter", "NumericFieldRangeFilter" ], "type": "string", "description": "Type of the facet. Depending on facet type, different parameters, combinations of parameters and parameter types are possible." } }, "description": "Facets on content type. explicitValues is a list of content type names." }, "ContentTypeFieldNonResource": { "title": "Content type field non resource", "type": "object", "properties": { "fieldId": { "type": "string", "description": "The Id of the field registered on the content type", "format": "uuid" } }, "description": "Represents a field registered on the content type." }, "ContentTypeInfoResource": { "title": "Content type info resource", "type": "object", "properties": { "id": { "type": "string", "description": "Id of this content type.", "format": "uuid" }, "name": { "type": "string", "description": "Name of this content type." }, "parentId": { "type": [ "null", "string" ], "description": "ParentId of this content type or null then the content type is a root content type. For manual content types, when not specified, the parent will always fall back to the root Record content type", "format": "uuid" } }, "description": "Simple representation of a content type." }, "ContentTypeInheritableFieldNonResource": { "title": "Content type inheritable field non resource", "type": "object", "properties": { "fieldId": { "type": "string", "description": "The Id of the inheritable field registered on the content type", "format": "uuid" } }, "description": "Represents inheritable fields registered on the content type." }, "ContentTypeIsConditionModel": { "title": "Content type is condition model", "type": "object", "properties": { "contentTypes": { "type": "array", "items": { "type": "string" }, "description": "The content type name" }, "directLinkOnly": { "type": "boolean", "description": "Whether to only check direct links (not inherited)" }, "conditionType": { "description": "The type of condition. Determines which additional properties apply.", "$ref": "#/components/schemas/FileProcessConditionDataType" } }, "description": "Model for ContentTypeIs condition - checks if the record is of a specific content type" }, "ContentTypeIsRuleConditionModel": { "title": "Content type is rule condition model", "type": "object", "properties": { "directLinkOnly": { "type": "boolean", "description": "If true, only a direct link is considered" }, "contentType": { "type": "string", "description": "Content type name" }, "index": { "type": "integer", "description": "Index of the condition within the rule's condition collection", "format": "int32" }, "conditionType": { "description": "Type of condition to be evaluated.", "$ref": "#/components/schemas/RuleConditionDataType" } }, "description": "Model for ContentTypeIs rule condition" }, "ContentTypeIsRuleConditionNonResource": { "title": "Content type is rule condition non resource", "type": "object", "properties": { "contentType": { "type": "string", "description": "ContentType Name" }, "directLinkOnly": { "type": "boolean", "description": "Specifies whether is directly linked or not" }, "index": { "type": "integer", "description": "Index of a rule condition in collection", "format": "int32" }, "conditionType": { "description": "Data type of this rule condition", "$ref": "#/components/schemas/RuleConditionDataType" } }, "description": "Representation of content type is rule condition" }, "ContentTypePagedCollectionResource": { "title": "Content type paged collection resource", "type": "object", "properties": { "pageNumber": { "type": [ "null", "integer" ], "description": "The current page of this paged collection.", "format": "int32" }, "pageSize": { "type": [ "null", "integer" ], "description": "The current page size of this paged collection.", "format": "int32" }, "skip": { "type": [ "null", "integer" ], "description": "The current skip size of this paged collection.", "format": "int32" }, "take": { "type": [ "null", "integer" ], "description": "The current take size of this paged collection.", "format": "int32" }, "totalCount": { "type": "integer", "description": "The total count of items in this paged collection, not just on the current page.", "format": "int64" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ContentTypeResource" }, "description": "One page of this paged collection, which is a subcollection of the complete collection." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" }, "first": { "description": "A link to the first page of this paged collection.", "$ref": "#/components/schemas/Link" }, "prev": { "description": "A link to the previous page of this paged collection.", "$ref": "#/components/schemas/Link" }, "next": { "description": "A link to the next page of this paged collection.", "$ref": "#/components/schemas/Link" }, "last": { "description": "A link to the last page of this paged collection.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of a paged collection of content types" }, "ContentTypeResource": { "title": "Content type resource", "type": "object", "properties": { "id": { "type": "string", "description": "Id of this content type.", "format": "uuid" }, "name": { "type": "string", "description": "Name of this content type." }, "purpose": { "type": "string", "description": "Description text of this content type." }, "parentId": { "type": [ "null", "string" ], "description": "ParentId of this content type. Can be null when the content type is a root content type.", "format": "uuid" }, "isManual": { "type": "boolean", "description": "Indicates if a content type is predefined or a manually created content type." }, "isNoFile": { "type": "boolean", "description": "Indicates if a content type is a \"no-file\" content type or not." }, "registeredFields": { "type": "array", "items": { "$ref": "#/components/schemas/ContentTypeFieldNonResource" }, "description": "List of fields registered on this content type." }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelNonResource" }, "description": "Labels of this content type." }, "defaultFileExtensions": { "type": "array", "items": { "type": "string" }, "description": "Default file extensions that are registered on the content type." }, "titleConfiguration": { "oneOf": [ { "$ref": "#/components/schemas/FieldTitleConfigurationNonResource" }, { "$ref": "#/components/schemas/FileNameTitleConfigurationNonResource" } ], "description": "Content type title configuration", "discriminator": { "propertyName": "option", "mapping": { "Field": "#/components/schemas/FieldTitleConfigurationNonResource", "FileName": "#/components/schemas/FileNameTitleConfigurationNonResource" } } }, "inheritanceConfiguration": { "enum": [ "None", "Parent", "Custom" ], "type": "string", "description": "Content type inheritance configuration" }, "inheritanceFieldId": { "type": [ "null", "string" ], "description": "Content type relation field id", "format": "uuid" }, "inheritableFields": { "type": "array", "items": { "$ref": "#/components/schemas/ContentTypeInheritableFieldNonResource" }, "description": "Content type inheritable fields" }, "fileMode": { "enum": [ "UploadFile", "NoFile", "CreateFromUrl", "CreateFromSmartAgent", "ManagedInDam" ], "type": "string", "description": "Indicates what file mode the content type uses." }, "fileConfiguration": { "description": "Configuration used to populate the file automatically, such as the URL crawl settings or smart agent id. Only relevant when FileMode is CreateFromUrl or CreateFromSmartAgent.", "$ref": "#/components/schemas/FileConfigurationNonResource" }, "registeredFieldGroups": { "type": "array", "items": { "$ref": "#/components/schemas/RegisteredFieldGroupNonResource" }, "description": "Registered field groups for this content type." }, "modifiedOn": { "type": "string", "description": "Last modification datetime in UTC time.", "format": "date-time" }, "createdOn": { "type": "string", "description": "Creation datetime in UTC time.", "format": "date-time" }, "_links": { "type": "object", "properties": { "parent": { "description": "Relation to the parent.", "$ref": "#/components/schemas/Link" }, "modifiedBy": { "description": "Relation to the user who last modified this content type.", "$ref": "#/components/schemas/Link" }, "createdBy": { "description": "Relation to the user who created this content type.", "$ref": "#/components/schemas/Link" }, "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "parent": { "description": "Relation to the parent. Embed via a \"select-contenttype: parent\" header.", "$ref": "#/components/schemas/ContentTypeResource" }, "modifiedBy": { "description": "Relation to the user who last modified this content type. Embed via a \"select-contenttype: modifiedBy\" header.", "$ref": "#/components/schemas/UserResource" }, "createdBy": { "description": "Relation to the user who created this content type. Embed via a \"select-contenttype: createdBy\" header.", "$ref": "#/components/schemas/UserResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "Defines which fields, classifications, and rules apply to a record based on what kind of record it is (e.g. \"Image\", \"Video\", \"Document\"). Every record has exactly one content type." }, "CounterCollectionResource": { "title": "Counter collection resource", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CounterNonResource" }, "description": "A collection of non-resource items." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of a non-paged collection of counters" }, "CounterEditCommand": { "title": "Counter edit command", "type": "object", "properties": { "name": { "type": "string", "description": "Name of the counter." }, "value": { "type": "integer", "description": "Value of the counter.", "format": "int64" } }, "description": "Command to update an existing counter." }, "CounterNonResource": { "title": "Counter non resource", "type": "object", "properties": { "name": { "type": "string", "description": "Name of this counter." }, "value": { "type": "integer", "description": "Value of this counter.", "format": "int64" } }, "description": "A named, persistent, atomically-incrementing integer sequence, typically used to generate a unique, ever-increasing value (e.g. an invoice number or SKU) for a custom field." }, "CreatableByResourceOfTResourceRelation": { "title": "Creatable by resource of t resource relation", "type": "object", "properties": { "createdOn": { "type": "string", "description": "Creation datetime in UTC time.", "format": "date-time" }, "_links": { "type": "object", "properties": { "createdBy": { "description": "User that created this resource.", "$ref": "#/components/schemas/Link" }, "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Base representation of a creatable by resource" }, "CreateActivityRuleActionModel": { "title": "Create activity rule action model", "type": "object", "properties": { "activityDuration": { "type": "integer", "description": "Duration of the activity, in minutes.", "format": "int32" }, "activityTypeId": { "type": "integer", "description": "Id of the activity type.", "format": "int32" }, "digitalAssetType": { "type": [ "null", "integer" ], "description": "Id of the digital asset type.", "format": "int32" }, "activityOwner": { "type": "string", "description": "Owner of the activity. Accepts a plain integer user id, a user GUID, a user name, or a reference expression resolved against the record (same convention as other rule actions' Reference-style properties, e.g. Reference)." }, "activityAdmin": { "type": "string", "description": "Admin of the activity. Same accepted shapes as ActivityOwner." }, "index": { "type": "integer", "description": "Index of the action within the rule's action collection", "format": "int32" }, "actionType": { "description": "Type of action to be executed.", "$ref": "#/components/schemas/RuleActionDataType" }, "executionTime": { "description": "When the action should be executed.", "$ref": "#/components/schemas/RuleExecutionTime" } }, "description": "Model for CreateActivity rule action" }, "CreateActivityRuleActionNonResource": { "title": "Create activity rule action non resource", "type": "object", "properties": { "activityDuration": { "type": "integer", "description": "Duration of the activity, in minutes.", "format": "int32" }, "activityTypeId": { "type": "integer", "description": "Id of the activity type.", "format": "int32" }, "digitalAssetType": { "type": [ "null", "integer" ], "description": "Id of the digital asset type, if configured.", "format": "int32" }, "activityOwner": { "type": "string", "description": "Owner of the activity as stored (plain id, GUID, user name, or reference expression), if configured." }, "activityAdmin": { "type": "string", "description": "Admin of the activity as stored (plain id, GUID, user name, or reference expression), if configured." }, "index": { "type": "integer", "description": "Index of a rule action in collection", "format": "int32" }, "actionType": { "description": "Data type of this rule action", "$ref": "#/components/schemas/RuleActionDataType" }, "executionTime": { "description": "Execution time of the rule action", "$ref": "#/components/schemas/RuleExecutionTime" } }, "description": "Representation of Create Activity rule action" }, "CreateCheckCommand": { "title": "Create check command", "type": "object", "properties": { "name": { "type": "string", "description": "Name of the check." }, "actionTypeId": { "type": "string", "description": "Identifier of the action type associated with this check.", "format": "uuid" }, "checkCategoryId": { "type": "string", "description": "Identifier of the check category this check belongs to.", "format": "uuid" }, "isActive": { "type": "boolean", "description": "Whether the check is active. Defaults to true." }, "isDeletable": { "type": "boolean", "description": "Whether the check can be deleted. Defaults to true." }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelModel" }, "description": "Multi-language labels for this check" } }, "description": "Creates a new check." }, "CreateFileVersionCheckResultCommand": { "title": "Create file version check result command", "type": "object", "properties": { "fileVersionId": { "type": "string", "description": "Identifier of the file version the check result applies to.", "format": "uuid" }, "checkId": { "type": "string", "description": "Identifier of the check that produced this result.", "format": "uuid" }, "description": { "type": "string", "description": "Description of the check result." }, "outcome": { "type": "string", "description": "Outcome of the check." }, "findings": { "type": "array", "items": { "$ref": "#/components/schemas/CreateFileVersionCheckResultFindingData" }, "description": "Optional findings for this check result. If provided, findings will be created along with the check result." } }, "description": "Creates a check result for a file version." }, "CreateFileVersionCheckResultFindingCommand": { "title": "Create file version check result finding command", "type": "object", "properties": { "fileVersionCheckId": { "type": "string", "description": "Identifier of the file version check result this finding belongs to.", "format": "uuid" }, "occurrence": { "type": "integer", "description": "Occurrence number of the finding within the check result.", "format": "int32" }, "finding": { "type": "string", "description": "Description of the finding." }, "explanation": { "type": "string", "description": "Explanation of the finding." }, "recommendation": { "type": "string", "description": "Recommendation associated with the finding." }, "additionalData": { "type": "string", "description": "Additional data associated with the finding." }, "outcome": { "type": "string", "description": "Outcome of the finding." } }, "description": "Creates a finding for an existing file version check result." }, "CreateFileVersionCheckResultFindingData": { "title": "Create file version check result finding data", "type": "object", "properties": { "occurrence": { "type": "integer", "description": "Occurrence number of the finding within the check result.", "format": "int32" }, "finding": { "type": "string", "description": "Description of the finding." }, "explanation": { "type": "string", "description": "Explanation of the finding." }, "recommendation": { "type": "string", "description": "Recommendation associated with the finding." }, "additionalData": { "type": "string", "description": "Additional data associated with the finding." }, "outcome": { "type": "string", "description": "Outcome of the finding." } }, "description": "Data structure for creating a finding within a check result" }, "CreatePresetCropsActionParametersModel": { "title": "Create preset crops action parameters model", "type": "object", "description": "Parameters for the \"CreatePresetCrops\" maintenance job action. This action takes no parameters." }, "CreatePresetCropsRuleActionModel": { "title": "Create preset crops rule action model", "type": "object", "properties": { "index": { "type": "integer", "description": "Index of the action within the rule's action collection", "format": "int32" }, "actionType": { "description": "Type of action to be executed.", "$ref": "#/components/schemas/RuleActionDataType" }, "executionTime": { "description": "When the action should be executed.", "$ref": "#/components/schemas/RuleExecutionTime" } }, "description": "Model for CreatePresetCrops rule action" }, "CreatePresetCropsRuleActionNonResource": { "title": "Create preset crops rule action non resource", "type": "object", "properties": { "index": { "type": "integer", "description": "Index of a rule action in collection", "format": "int32" }, "actionType": { "description": "Data type of this rule action", "$ref": "#/components/schemas/RuleActionDataType" }, "executionTime": { "description": "Execution time of the rule action", "$ref": "#/components/schemas/RuleExecutionTime" } }, "description": "Representation of the Create Preset Crops rule action, which generates crops for the configured crop presets." }, "CreatePublicLinksActionParametersModel": { "title": "Create public links action parameters model", "type": "object", "properties": { "presets": { "type": "array", "items": { "$ref": "#/components/schemas/PublicLinkPresetParametersModel" }, "description": "Presets to generate public links for." } }, "description": "Parameters for the \"CreatePublicLinks\" maintenance job action. At least one preset is required (a runtime check, not enforced by this schema)." }, "CreatePublicUrisRuleActionModel": { "title": "Create public uris rule action model", "type": "object", "properties": { "presets": { "type": "array", "items": { "$ref": "#/components/schemas/PublicUriPreset" }, "description": "Presets to create public links for" }, "index": { "type": "integer", "description": "Index of the action within the rule's action collection", "format": "int32" }, "actionType": { "description": "Type of action to be executed.", "$ref": "#/components/schemas/RuleActionDataType" }, "executionTime": { "description": "When the action should be executed.", "$ref": "#/components/schemas/RuleExecutionTime" } }, "description": "Model for CreatePublicLinks rule action" }, "CreatePublicUrisRuleActionNonResource": { "title": "Create public uris rule action non resource", "type": "object", "properties": { "presets": { "type": "array", "items": { "$ref": "#/components/schemas/PublicUriPreset" }, "description": "Controls which presets will be used." }, "index": { "type": "integer", "description": "Index of a rule action in collection", "format": "int32" }, "actionType": { "description": "Data type of this rule action", "$ref": "#/components/schemas/RuleActionDataType" }, "executionTime": { "description": "Execution time of the rule action", "$ref": "#/components/schemas/RuleExecutionTime" } }, "description": "Representation of Create Public Uris rule action" }, "CreateRenditionsActionParametersModel": { "title": "Create renditions action parameters model", "type": "object", "properties": { "presets": { "type": "array", "items": { "type": "string" }, "description": "Names of the rendition presets to create." } }, "description": "Parameters for the \"CreateRenditions\" maintenance job action." }, "CreateRenditionsRuleActionModel": { "title": "Create renditions rule action model", "type": "object", "properties": { "renditionPresets": { "type": "array", "items": { "type": "string" }, "description": "Names of the rendition presets to execute, configured via the .renditionPreset setting." }, "index": { "type": "integer", "description": "Index of the action within the rule's action collection", "format": "int32" }, "actionType": { "description": "Type of action to be executed.", "$ref": "#/components/schemas/RuleActionDataType" }, "executionTime": { "description": "When the action should be executed.", "$ref": "#/components/schemas/RuleExecutionTime" } }, "description": "Model for CreateRenditions rule action" }, "CreateRenditionsRuleActionNonResource": { "title": "Create renditions rule action non resource", "type": "object", "properties": { "renditionPresets": { "type": "array", "items": { "type": "string" }, "description": "Controls which presets will be used." }, "index": { "type": "integer", "description": "Index of a rule action in collection", "format": "int32" }, "actionType": { "description": "Data type of this rule action", "$ref": "#/components/schemas/RuleActionDataType" }, "executionTime": { "description": "Execution time of the rule action", "$ref": "#/components/schemas/RuleExecutionTime" } }, "description": "Representation of Create Renditions rule action" }, "CreateReviewFileActionParametersModel": { "title": "Create review file action parameters model", "type": "object", "description": "Parameters for the \"CreateReviewFile\" maintenance job action. This action takes no parameters." }, "CreateReviewFileRuleActionModel": { "title": "Create review file rule action model", "type": "object", "properties": { "index": { "type": "integer", "description": "Index of the action within the rule's action collection", "format": "int32" }, "actionType": { "description": "Type of action to be executed.", "$ref": "#/components/schemas/RuleActionDataType" }, "executionTime": { "description": "When the action should be executed.", "$ref": "#/components/schemas/RuleExecutionTime" } }, "description": "Model for CreateReviewFile rule action" }, "CreateReviewFileRuleActionNonResource": { "title": "Create review file rule action non resource", "type": "object", "properties": { "index": { "type": "integer", "description": "Index of a rule action in collection", "format": "int32" }, "actionType": { "description": "Data type of this rule action", "$ref": "#/components/schemas/RuleActionDataType" }, "executionTime": { "description": "Execution time of the rule action", "$ref": "#/components/schemas/RuleExecutionTime" } }, "description": "Representation of Create Review file rule action" }, "CreateSearchIndexCommand": { "title": "Create search index command", "type": "object", "properties": { "rebuildScheduled": { "type": "boolean", "description": "When set, schedules the rebuild instead of running it immediately." }, "rebuildTarget": { "description": "Resource type to rebuild the index for.", "$ref": "#/components/schemas/IndexRebuildTargetResource" } }, "description": "Triggers (re)creation of the search index." }, "CreateUniqueKeyIndexCommand": { "title": "Create unique key index command", "type": "object", "description": "Triggers (re)creation of the unique key index." }, "CreatedResourceId": { "title": "Created resource id", "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } }, "CreatedResourceIdOfInt32": { "title": "Created resource id of int32", "type": "object", "properties": { "id": { "type": "integer", "format": "int32" } } }, "CropImageActionParametersModel": { "title": "Crop image action parameters model", "type": "object", "properties": { "name": { "type": "string", "description": "Name for the resulting cropped rendition." }, "crop": { "description": "Pixel region to crop from the source image.", "$ref": "#/components/schemas/CropRegionModel" }, "resizeWidth": { "type": "integer", "description": "Width to resize the cropped result to. Defaults to the crop region's own width.", "format": "int32" }, "resizeHeight": { "type": "integer", "description": "Height to resize the cropped result to. Defaults to the crop region's own height.", "format": "int32" }, "resolution": { "type": "integer", "description": "Output resolution (DPI) for the cropped result.", "format": "int32" }, "id": { "type": "string", "description": "Id to assign to the resulting crop, if a specific one is required.", "format": "uuid" }, "format": { "type": "string", "description": "Output image format. One of the \"ResizeImageFormat\" values (e.g. \"Jpeg\", \"Png\", \"KeepOriginal\"); defaults to \"KeepOriginal\" when omitted." }, "colorSpace": { "type": "string", "description": "Output color space. One of the \"ResizeImageColorSpace\" values (e.g. \"Srgb\", \"Cmyk\", \"KeepOriginal\"); defaults to \"KeepOriginal\" when omitted." }, "preset": { "type": "string", "description": "Name of a pre-configured crop preset to use instead of specifying dimensions directly." } }, "description": "Parameters for the \"CropImage\" maintenance job action." }, "CropPresetStatus": { "title": "Crop preset status", "enum": [ "Original", "Modified", "Removed" ], "type": "string", "x-enum-descriptions": [ "The crop matches the original preset.", "The crop was modified from the preset.", "The preset used to create the crop was removed." ] }, "CropRegionModel": { "title": "Crop region model", "type": "object", "properties": { "x": { "type": "integer", "description": "Left edge of the crop region, in pixels.", "format": "int32" }, "y": { "type": "integer", "description": "Top edge of the crop region, in pixels.", "format": "int32" }, "width": { "type": "integer", "description": "Width of the crop region, in pixels.", "format": "int32" }, "height": { "type": "integer", "description": "Height of the crop region, in pixels.", "format": "int32" } }, "description": "Pixel region to crop from the source image, used by the \"CropImage\" maintenance job action." }, "CropRenditionResource": { "title": "Crop rendition resource", "type": "object", "properties": { "x": { "type": "integer", "description": "The x coordinate of the position of the crop", "format": "int32" }, "y": { "type": "integer", "description": "The y coordinate of the position of the crop", "format": "int32" }, "width": { "type": "integer", "description": "The width of the crop", "format": "int32" }, "height": { "type": "integer", "description": "The height of the crop", "format": "int32" }, "resizeWidth": { "type": "integer", "description": "The resize width of the crop", "format": "int32" }, "resizeHeight": { "type": "integer", "description": "The resize height of the crop", "format": "int32" }, "resolution": { "type": "integer", "description": "The resolution of the crop", "format": "int32" }, "colorSpace": { "description": "The color space of the crop", "$ref": "#/components/schemas/ColorSpace" }, "resizeFormat": { "type": "string", "description": "The resize format of the crop" }, "presetName": { "type": "string", "description": "The preset name of the crop" }, "presetHash": { "type": "string", "description": "The preset hash of the crop" }, "isSmart": { "type": "boolean", "description": "Whether or not this is a smart crop" }, "isPreset": { "type": "boolean", "description": "Whether or not this is a preset crop" }, "id": { "type": "string", "description": "Identifier for the rendition", "format": "uuid" }, "uri": { "type": "string", "description": "Uri for this rendition Opt-in: returned only when requested. Include via a \"select-rendition: Uri\" header." }, "type": { "enum": [ "Original", "Preset", "Crop", "Trim", "Custom" ], "type": "string", "description": "Rendition type" }, "name": { "type": "string", "description": "Rendition name" }, "extension": { "type": "string", "description": "The extension of the rendition" }, "preview": { "type": "string", "description": "The preview of the rendition Opt-in: returned only when requested. Include via a \"select-rendition: Preview\" header." }, "publishedUri": { "type": "string", "description": "Shortcut property to the URI of the published public link of the rendition Opt-in: returned only when requested. Include via a \"select-rendition: PublishedUri\" header." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" }, "publicLinks": { "description": "Relation to the rendition public links.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "publicLinks": { "description": "Relation to the rendition public links. Embed via a \"select-rendition: publicLinks\" header.", "$ref": "#/components/schemas/PublicLinkCollectionResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "Representation of a rendition" }, "CropResource": { "title": "Crop resource", "type": "object", "properties": { "preview": { "type": "string", "description": "The preview of the crop Opt-in: returned only when requested. Include via a \"select-additionalfile: Preview\" header." }, "x": { "type": "integer", "description": "The X coordinate of the crop.", "format": "int32" }, "y": { "type": "integer", "description": "The Y coordinate of the crop.", "format": "int32" }, "width": { "type": "integer", "description": "The width of the crop.", "format": "int32" }, "height": { "type": "integer", "description": "The height of the crop.", "format": "int32" }, "resizeWidth": { "type": "integer", "description": "The resize width of the crop.", "format": "int32" }, "resizeHeight": { "type": "integer", "description": "The resize height of the crop.", "format": "int32" }, "resolution": { "type": "integer", "description": "The resolution of the crop.", "format": "int32" }, "colorSpace": { "description": "The color space of the crop.", "$ref": "#/components/schemas/ColorSpace" }, "resizeFormat": { "type": "string", "description": "The resize format of the crop." }, "presetName": { "type": "string", "description": "The preset name of the crop." }, "presetHash": { "type": "string", "description": "The preset hash of the crop." }, "isSmart": { "type": "boolean", "description": "Is this a smart crop?" }, "isPreset": { "type": "boolean", "description": "Is this a preset crop?" }, "cropPresetStatus": { "description": "Is this crop created with an old version of the preset", "$ref": "#/components/schemas/CropPresetStatus" }, "id": { "type": "string", "description": "Identifier for this additional file.", "format": "uuid" }, "type": { "description": "Type of this additional file. On the additional files collection endpoint, the results can be restricted to specific types with a \"select-additionalfile-type\" request header (comma-separated AdditionalFileType names).", "$ref": "#/components/schemas/AdditionalFileType" }, "isManual": { "type": "boolean", "description": "Returns true if this additional has been added manually. false is returned if the additional file was created automatically." }, "label": { "type": "string", "description": "Label of the additional file" }, "fileSize": { "type": "integer", "description": "File size of the additional file", "format": "int64" }, "fileName": { "type": "string", "description": "File name of the additional file" }, "extension": { "type": "string", "description": "File extension of the additional file" }, "tag": { "type": "string", "description": "Tag of the additional file Opt-in: returned only when requested. Include via a \"select-additionalfile: Tag\" header." }, "usages": { "type": "array", "items": { "type": "string" }, "description": "Usages of the additional file. On the additional files collection endpoint, the results can be restricted to specific usages with a \"select-additionalfile-usage\" request header (comma-separated values)." }, "uri": { "type": "string", "description": "Returns a path to image or if no image is assigned. This URL remains valid for four hours. Opt-in: returned only when requested. Include via a \"select-additionalfile: Uri\" header." }, "metadata": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Technical metadata specific to this additional file's type (e.g. video duration, image resolution). The available keys vary by file type and aren't individually documented. Opt-in: returned only when requested. Include via a \"select-additionalfile: Metadata\" header." }, "purposes": { "type": "array", "items": { "type": "string" }, "description": "Purposes of the additional file. On the additional files collection endpoint, the results can be restricted to specific purposes with a \"select-filter-purposes\" request header (comma-separated values)." }, "crc32": { "type": "integer", "description": "CRC32 checksum of this additional file.", "format": "int32" }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" }, "publicLink": { "description": "Relation to the addition file public link.", "$ref": "#/components/schemas/Link" }, "mainPreview": { "description": "Relation to an image of main preview with the size of a preview.", "$ref": "#/components/schemas/Link" }, "filePreviews": { "description": "Relation to a collection of file previews.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "publicLink": { "description": "Relation to the addition file public link. Embed via a \"select-additionalfile: publicLink\" header.", "$ref": "#/components/schemas/PublicLinkResource" }, "mainPreview": { "description": "Relation to an image of main preview with the size of a preview. Embed via a \"select-additionalfile: mainPreview\" header.", "$ref": "#/components/schemas/ImageResource" }, "filePreviews": { "description": "Relation to a collection of file previews. Embed via a \"select-additionalfile: filePreviews\" header.", "$ref": "#/components/schemas/AdditionalFilePreviewCollectionResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "A user-defined crop of an image, storing the crop rectangle, resize dimensions, and color space used to produce a rendition." }, "CspResource": { "title": "Csp resource", "type": "object", "properties": { "domains": { "type": "array", "items": { "type": "string" }, "description": "The domains allowed by this Content Security Policy." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "The Content Security Policy domain allowlist for this DAM instance." }, "CurrentlyLoggedOnUserRuleConditionModel": { "title": "Currently logged on user rule condition model", "type": "object", "properties": { "userId": { "type": "string", "description": "Id of the user to compare against the currently logged on user", "format": "uuid" }, "isUser": { "type": "boolean", "description": "If true, the currently logged on user must match UserId; if false, it must not match" }, "index": { "type": "integer", "description": "Index of the condition within the rule's condition collection", "format": "int32" }, "conditionType": { "description": "Type of condition to be evaluated.", "$ref": "#/components/schemas/RuleConditionDataType" } }, "description": "Model for CurrentlyLoggedOnUser rule condition" }, "CurrentlyLoggedOnUserRuleConditionNonResource": { "title": "Currently logged on user rule condition non resource", "type": "object", "properties": { "userId": { "type": "string", "description": "User's id", "format": "uuid" }, "isUser": { "type": "boolean", "description": "Whether the user triggering the rule matches the specified user or not" }, "index": { "type": "integer", "description": "Index of a rule condition in collection", "format": "int32" }, "conditionType": { "description": "Data type of this rule condition", "$ref": "#/components/schemas/RuleConditionDataType" } }, "description": "Representation of Currently logged on user rule" }, "CustomFileResource": { "title": "Custom file resource", "type": "object", "properties": { "width": { "type": "integer", "description": "Width of the custom file.", "format": "int32" }, "height": { "type": "integer", "description": "Height of the custom file.", "format": "int32" }, "presetName": { "type": "string", "description": "Preset name of the custom file." }, "presetHash": { "type": "string", "description": "Preset hash of the custom file." }, "id": { "type": "string", "description": "Identifier for this additional file.", "format": "uuid" }, "type": { "description": "Type of this additional file. On the additional files collection endpoint, the results can be restricted to specific types with a \"select-additionalfile-type\" request header (comma-separated AdditionalFileType names).", "$ref": "#/components/schemas/AdditionalFileType" }, "isManual": { "type": "boolean", "description": "Returns true if this additional has been added manually. false is returned if the additional file was created automatically." }, "label": { "type": "string", "description": "Label of the additional file" }, "fileSize": { "type": "integer", "description": "File size of the additional file", "format": "int64" }, "fileName": { "type": "string", "description": "File name of the additional file" }, "extension": { "type": "string", "description": "File extension of the additional file" }, "tag": { "type": "string", "description": "Tag of the additional file Opt-in: returned only when requested. Include via a \"select-additionalfile: Tag\" header." }, "usages": { "type": "array", "items": { "type": "string" }, "description": "Usages of the additional file. On the additional files collection endpoint, the results can be restricted to specific usages with a \"select-additionalfile-usage\" request header (comma-separated values)." }, "uri": { "type": "string", "description": "Returns a path to image or if no image is assigned. This URL remains valid for four hours. Opt-in: returned only when requested. Include via a \"select-additionalfile: Uri\" header." }, "metadata": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Technical metadata specific to this additional file's type (e.g. video duration, image resolution). The available keys vary by file type and aren't individually documented. Opt-in: returned only when requested. Include via a \"select-additionalfile: Metadata\" header." }, "purposes": { "type": "array", "items": { "type": "string" }, "description": "Purposes of the additional file. On the additional files collection endpoint, the results can be restricted to specific purposes with a \"select-filter-purposes\" request header (comma-separated values)." }, "crc32": { "type": "integer", "description": "CRC32 checksum of this additional file.", "format": "int32" }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" }, "publicLink": { "description": "Relation to the addition file public link.", "$ref": "#/components/schemas/Link" }, "mainPreview": { "description": "Relation to an image of main preview with the size of a preview.", "$ref": "#/components/schemas/Link" }, "filePreviews": { "description": "Relation to a collection of file previews.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "publicLink": { "description": "Relation to the addition file public link. Embed via a \"select-additionalfile: publicLink\" header.", "$ref": "#/components/schemas/PublicLinkResource" }, "mainPreview": { "description": "Relation to an image of main preview with the size of a preview. Embed via a \"select-additionalfile: mainPreview\" header.", "$ref": "#/components/schemas/ImageResource" }, "filePreviews": { "description": "Relation to a collection of file previews. Embed via a \"select-additionalfile: filePreviews\" header.", "$ref": "#/components/schemas/AdditionalFilePreviewCollectionResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "Representation of a custom file" }, "CustomRenditionResource": { "title": "Custom rendition resource", "type": "object", "properties": { "metadata": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Technical metadata specific to this rendition's type. The available keys vary and aren't individually documented. Opt-in: returned only when requested. Include via a \"select-customrendition: Metadata\" header." }, "id": { "type": "string", "description": "Identifier for the rendition", "format": "uuid" }, "uri": { "type": "string", "description": "Uri for this rendition Opt-in: returned only when requested. Include via a \"select-rendition: Uri\" header." }, "type": { "enum": [ "Original", "Preset", "Crop", "Trim", "Custom" ], "type": "string", "description": "Rendition type" }, "name": { "type": "string", "description": "Rendition name" }, "extension": { "type": "string", "description": "The extension of the rendition" }, "preview": { "type": "string", "description": "The preview of the rendition Opt-in: returned only when requested. Include via a \"select-rendition: Preview\" header." }, "publishedUri": { "type": "string", "description": "Shortcut property to the URI of the published public link of the rendition Opt-in: returned only when requested. Include via a \"select-rendition: PublishedUri\" header." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" }, "publicLinks": { "description": "Relation to the rendition public links.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "publicLinks": { "description": "Relation to the rendition public links. Embed via a \"select-rendition: publicLinks\" header.", "$ref": "#/components/schemas/PublicLinkCollectionResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "Representation of a rendition" }, "DateFieldDefinitionCreateCommand": { "title": "Date field definition create command", "type": "object", "properties": { "datePattern": { "type": "string", "description": "Pattern used to format and parse the date value." }, "yearMonthPattern": { "type": "string", "description": "Pattern used to format and parse the date value when only year and month are captured." }, "metadataPredictionEnabled": { "type": "boolean", "description": "When set to true, this field's value can be predicted using AI-based metadata prediction." }, "hints": { "type": "string", "description": "Hints used to guide AI-based metadata prediction for this field." }, "dataType": { "description": "Data type of the field definition. Determines which other properties apply.", "$ref": "#/components/schemas/FieldDefinitionType" }, "enabledLanguages": { "description": "Languages in which this field is enabled. Use AddOrUpdate to add or update members, or Remove to remove them.", "$ref": "#/components/schemas/EditableIdCollectionModel" }, "indexed": { "type": "boolean", "description": "When set to true, the field is indexed for search." }, "inlineStyle": { "type": "string", "description": "Inline CSS style applied to the field in the DAM UI." }, "isReadOnly": { "type": "boolean", "description": "When set to true, the field cannot be edited." }, "isRequired": { "type": "boolean", "description": "When set to true, the field is required." }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelModel" }, "description": "Multi-language labels for the name of this field." }, "languageMode": { "type": "string", "description": "Language mode of the field." }, "memberships": { "description": "Field groups this field is a member of. Use AddOrUpdate to add or update members, or Remove to remove them.", "$ref": "#/components/schemas/EditableIdCollectionModel" }, "name": { "type": "string", "description": "Name of the field." }, "scope": { "type": "string", "description": "Scope of the field." }, "sortIndex": { "type": "integer", "description": "Sort index used to order the field relative to other fields.", "format": "int32" }, "tag": { "type": "string", "description": "Tag associated with the field." }, "defaultValue": { "type": "string", "description": "Default value assigned to the field." }, "resetToDefaultTriggers": { "type": "array", "items": { "type": "string" }, "description": "Names of the triggers that reset the field to its default value." }, "resetToDefaultFields": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Ids of the fields that reset this field to its default value when they change." }, "validation": { "type": "string", "description": "Validation expression applied to the field value." }, "validationErrorMessage": { "type": "string", "description": "Error message shown when validation fails." }, "validationTrigger": { "type": "string", "description": "Trigger that determines when validation is applied." }, "storageMode": { "type": "string", "description": "Storage mode of the field." }, "helpTexts": { "type": "array", "items": { "$ref": "#/components/schemas/HelpTextModel" }, "description": "Multi-language help texts for this field." } }, "description": "Command to create a date field definition." }, "DateFieldDefinitionResource": { "title": "Date field definition resource", "type": "object", "properties": { "yearMonthPattern": { "type": "string", "description": "Year month pattern." }, "datePattern": { "type": "string", "description": "Date pattern." }, "metadataPredictionEnabled": { "type": "boolean", "description": "Indicates whether the field can be predicted by the AI." }, "hints": { "type": "string", "description": "AI Prediction hint for this field." }, "label": { "type": "string", "description": "Label of this field." }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelNonResource" }, "description": "A collection of Label items." }, "dataType": { "$ref": "#/components/schemas/FieldDataType" }, "scope": { "enum": [ "RecordContentGlobal", "RecordContentClassDependent", "RecordContentFloating", "ClassificationProfileClassDependent", "UserGlobal", "FileFileTypeDependent", "FileFloating", "IndexerTaskGlobal", "FileGlobal", "ClassificationProfileFloating", "RecordContentContentTypeDependent" ], "type": "string", "description": "Scope." }, "scopeCategory": { "enum": [ "Record", "File", "Classification", "User", "IndexerTask", "MetadataTemplate" ], "type": "string", "description": "Scope category." }, "indexed": { "type": "boolean", "description": "Indicator if searching on this field is enabled." }, "languageMode": { "enum": [ "Single", "Multiple" ], "type": "string", "description": "Language mode of the field." }, "memberships": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Memberships of a field." }, "searchIndexRebuildRequired": { "type": "boolean", "description": "Indicator if a search index rebuild is required." }, "enabledLanguages": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Enabled languages." }, "id": { "type": "string", "description": "Identifier for this field.", "format": "uuid" }, "name": { "type": "string", "description": "Name for this field." }, "isRequired": { "type": "boolean", "description": "Indicates whether this field is required." }, "isReadOnly": { "type": "boolean", "description": "Indicates whether this field is read only." }, "isUniqueIdentifier": { "type": "boolean", "description": "Indicates whether this field is a unique identifier." }, "inlineStyle": { "type": "string", "description": "Inline CSS style applied to this field." }, "sortIndex": { "type": "integer", "description": "Sorting index of this field.", "format": "int32" }, "tag": { "type": "string", "description": "Tag for this field containing extra information. Opt-in: returned only when requested. Include via a \"select-fielddefinition: Tag\" header." }, "createdOn": { "type": "string", "description": "Created on the specified date in UTC time", "format": "date-time" }, "modifiedOn": { "type": "string", "description": "Modified on the specified date in UTC time", "format": "date-time" }, "defaultValue": { "type": "string", "description": "Default value of this field." }, "resetToDefaultTriggers": { "type": "array", "items": { "enum": [ "None", "OnNewField", "OnLoad", "OnSave", "OnAnyFileChange", "OnReclassifyRecord", "OnAnyChange", "OnFieldChange", "OnMasterFileChange", "OnCurrentFileChange", "OnFieldDefinitionChanged", "OnDuplicateRecord", "OnRecordStatusChange" ], "type": "string" }, "description": "'reset to default triggers' value of this field." }, "validation": { "type": "string", "description": "Validation of this field." }, "validationErrorMessage": { "type": "string", "description": "Error message of this field." }, "validationTrigger": { "enum": [ "None", "WhenNeeded", "Always" ], "type": "string", "description": "Trigger that determines when validation is evaluated for this field." }, "storageMode": { "enum": [ "None", "NonEmptyValues", "AllValues", "LogChanges" ], "type": "string", "description": "Storage mode of this field." }, "resetToDefaultFields": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Fields that trigger this field to be reset back to its default value. This is only used if \"ResetToDefaultTriggers\" is set to \"OnFieldChange\"." }, "helpText": { "type": "string", "description": "Help text of this field." }, "helpTexts": { "type": "array", "items": { "$ref": "#/components/schemas/HelpTextNonResource" }, "description": "A collection of HelpText items." }, "_links": { "type": "object", "properties": { "createdBy": { "description": "Relation to the user who created this field definition.", "$ref": "#/components/schemas/Link" }, "modifiedBy": { "description": "Relation to the user who last modified this field definition.", "$ref": "#/components/schemas/Link" }, "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "createdBy": { "description": "Relation to the user who created this field definition. Embed via a \"select-fielddefinition: createdBy\" header.", "$ref": "#/components/schemas/UserResource" }, "modifiedBy": { "description": "Relation to the user who last modified this field definition. Embed via a \"select-fielddefinition: modifiedBy\" header.", "$ref": "#/components/schemas/UserResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "Representation of the definition of a date field" }, "DateFieldRangeFacetModel": { "title": "Date field range facet model", "type": "object", "properties": { "rangeStart": { "type": [ "null", "string" ], "description": "Start of the range to take into account. Cannot be specified if explicitRanges is specified.", "format": "date-time" }, "rangeEnd": { "type": [ "null", "string" ], "description": "End of the range to take into account. Cannot be specified if explicitRanges is specified.", "format": "date-time" }, "spans": { "type": "array", "items": { "type": "string" }, "description": "Allows for the explicit specification of spans to divide the facet into. If the range specified is larger than the sum of all spans, the last span is repeated to cover the entire range. Cannot be specified if explicitRanges is specified. If spans is specified, rangeStart and rangeEnd are mandatory." }, "boundaries": { "type": "array", "items": { "enum": [ "None", "Lower", "Upper", "Edge", "All" ], "type": "string" }, "description": "Specifies how to include hits that fall on range or span boundaries. Defaults to None." }, "fieldId": { "type": [ "null", "string" ], "description": "The id of the field this facet should operate on.", "format": "uuid" }, "filters": { "type": "array", "items": { "type": "string" }, "description": "Filters allow you to limit the hits returned without affecting facets. If filters are specified, the aggregated counts in the facets remain the same. However, only records that match the filter criteria specified in the facet are returned. The parameter type of the filters depends on the facet type, but is always the same type as explicitValues/explicitRanges." }, "explicitValues": { "type": "array", "items": { "type": "string" }, "description": "A list of values. When specified, only shows facets corresponding to the specified values. If not specified, all occurring values are included." }, "explicitRanges": { "type": "array", "items": { "type": "string" }, "description": "Allows for the explicit specification of ranges to include in the facet. If explicitRanges is specified, you cannot specify rangeStart, rangeEnd, or spans (on the concrete range facet type)." }, "name": { "type": "string", "description": "A textual identifier for this facet, used only by the client to correlate requests with responses." }, "type": { "enum": [ "NumericField", "NumericFieldRange", "Classification", "CreatedBy", "ModifiedBy", "FileType", "OptionListField", "TextField", "DateTimeFieldRange", "DateFieldRange", "CreatedOn", "ModifiedOn", "TimeFieldRange", "TextListField", "ContentType", "ClassificationListField", "DateFieldRangeFilter", "NumericFieldRangeFilter" ], "type": "string", "description": "Type of the facet. Depending on facet type, different parameters, combinations of parameters and parameter types are possible." } }, "description": "A range facet on a Date-type field's values." }, "DateFieldRangeFilterModel": { "title": "Date field range filter model", "type": "object", "properties": { "fieldId": { "type": [ "null", "string" ], "description": "The id of the field this facet should operate on.", "format": "uuid" }, "filters": { "type": "array", "items": { "type": "string" }, "description": "Filters allow you to limit the hits returned without affecting facets. If filters are specified, the aggregated counts in the facets remain the same. However, only records that match the filter criteria specified in the facet are returned. The parameter type of the filters depends on the facet type, but is always the same type as explicitValues/explicitRanges." }, "explicitValues": { "type": "array", "items": { "type": "string" }, "description": "A list of values. When specified, only shows facets corresponding to the specified values. If not specified, all occurring values are included." }, "explicitRanges": { "type": "array", "items": { "type": "string" }, "description": "Allows for the explicit specification of ranges to include in the facet. If explicitRanges is specified, you cannot specify rangeStart, rangeEnd, or spans (on the concrete range facet type)." }, "name": { "type": "string", "description": "A textual identifier for this facet, used only by the client to correlate requests with responses." }, "type": { "enum": [ "NumericField", "NumericFieldRange", "Classification", "CreatedBy", "ModifiedBy", "FileType", "OptionListField", "TextField", "DateTimeFieldRange", "DateFieldRange", "CreatedOn", "ModifiedOn", "TimeFieldRange", "TextListField", "ContentType", "ClassificationListField", "DateFieldRangeFilter", "NumericFieldRangeFilter" ], "type": "string", "description": "Type of the facet. Depending on facet type, different parameters, combinations of parameters and parameter types are possible." } }, "description": "Filters records by a Date-type field's value falling in a range, without generating facet value counts. filters contains the range(s) to take into account; if both rangeStart and rangeEnd are specified on a filter, only items in that range are returned, otherwise all items are returned." }, "DateFieldResource": { "title": "Date field resource", "type": "object", "properties": { "dataType": { "$ref": "#/components/schemas/FieldDataType" }, "fieldName": { "type": "string", "description": "Name of this field." }, "label": { "type": "string", "description": "Label of this field." }, "id": { "type": "string", "description": "Id of this field.", "format": "uuid" }, "localizedValues": { "type": "array", "items": { "$ref": "#/components/schemas/DateFieldValue" }, "description": "Language specific data of this field." }, "inheritanceState": { "enum": [ "None", "Inherited" ], "type": [ "null", "string" ], "description": "Inheritance State of this field. Opt-in: returned only when requested. Include via a \"select-field: InheritanceState\" header." }, "inheritable": { "type": [ "null", "boolean" ], "description": "Whether the field value can be used as a parent in inheritance hierarchy. Opt-in: returned only when requested. Include via a \"select-field: Inheritable\" header." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" }, "definition": { "description": "Relation to the field definition.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "definition": { "description": "Relation to the field definition. Embed via a \"select-datefield: definition\" header.", "$ref": "#/components/schemas/FieldDefinitionResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "Representation of a DateField" }, "DateFieldValue": { "title": "Date field value", "type": "object", "properties": { "value": { "type": "string", "description": "Date represented as a text in the following format: \"yyyy-MM-dd\"." }, "hasDay": { "type": [ "null", "boolean" ], "description": "Indicates if this date value contains a day." }, "hasMonth": { "type": [ "null", "boolean" ], "description": "Indicates if this date value contains a month." }, "aIInfluenced": { "type": "boolean", "description": "Flag to indicate whether the value has come from AI." }, "languageId": { "type": "string", "description": "The language id.", "format": "uuid" }, "readOnly": { "type": [ "null", "boolean" ], "description": "Tells if the field is read-only." }, "modifiedOn": { "type": "string", "description": "Contains the date/time when the field is last modified.", "format": "date-time" } }, "description": "Language-specific DateField value." }, "DateTimeFacetModel": { "title": "Date time facet model", "type": "object", "properties": { "rangeStart": { "type": [ "null", "string" ], "description": "Start date and time of the range to take into account. Cannot be specified if ExplicitRanges is specified.", "format": "date-time" }, "rangeEnd": { "type": [ "null", "string" ], "description": "End date and time of the range to take into account. Cannot be specified if ExplicitRanges is specified.", "format": "date-time" }, "spans": { "type": "array", "items": { "type": "string" }, "description": "Allows for the explicit specification of spans to divide the facet into. If the range specified is larger than the sum of all spans, the last span is repeated to cover the entire range. Cannot be specified if ExplicitRanges is specified. If Spans is specified, RangeStart and RangeEnd are mandatory." }, "boundaries": { "type": "array", "items": { "enum": [ "None", "Lower", "Upper", "Edge", "All" ], "type": "string" }, "description": "Specifies how to include hits that fall on range or span boundaries. Defaults to None." }, "filters": { "type": "array", "items": { "type": "string" }, "description": "Filters allow you to limit the hits returned without affecting facets. If filters are specified, the aggregated counts in the facets remain the same. However, only records that match the filter criteria specified in the facet are returned. The parameter type of the filters depends on the facet type, but is always the same type as explicitValues/explicitRanges." }, "explicitValues": { "type": "array", "items": { "type": "string" }, "description": "A list of values. When specified, only shows facets corresponding to the specified values. If not specified, all occurring values are included." }, "explicitRanges": { "type": "array", "items": { "type": "string" }, "description": "Allows for the explicit specification of ranges to include in the facet. If explicitRanges is specified, you cannot specify rangeStart, rangeEnd, or spans (on the concrete range facet type)." }, "name": { "type": "string", "description": "A textual identifier for this facet, used only by the client to correlate requests with responses." }, "type": { "enum": [ "NumericField", "NumericFieldRange", "Classification", "CreatedBy", "ModifiedBy", "FileType", "OptionListField", "TextField", "DateTimeFieldRange", "DateFieldRange", "CreatedOn", "ModifiedOn", "TimeFieldRange", "TextListField", "ContentType", "ClassificationListField", "DateFieldRangeFilter", "NumericFieldRangeFilter" ], "type": "string", "description": "Type of the facet. Depending on facet type, different parameters, combinations of parameters and parameter types are possible." } }, "description": "A range facet on the record's own CreatedOn or ModifiedOn timestamp (Type distinguishes which)." }, "DateTimeFieldDefinitionCreateCommand": { "title": "Date time field definition create command", "type": "object", "properties": { "datePattern": { "type": "string", "description": "Pattern used to format and parse the date value." }, "dateTimePattern": { "type": "string", "description": "Pattern used to format and parse the date and time value." }, "useUtc": { "type": "boolean", "description": "When set to true, the value is stored and interpreted as UTC." }, "metadataPredictionEnabled": { "type": "boolean", "description": "When set to true, this field's value can be predicted using AI-based metadata prediction." }, "hints": { "type": "string", "description": "Hints used to guide AI-based metadata prediction for this field." }, "dataType": { "description": "Data type of the field definition. Determines which other properties apply.", "$ref": "#/components/schemas/FieldDefinitionType" }, "enabledLanguages": { "description": "Languages in which this field is enabled. Use AddOrUpdate to add or update members, or Remove to remove them.", "$ref": "#/components/schemas/EditableIdCollectionModel" }, "indexed": { "type": "boolean", "description": "When set to true, the field is indexed for search." }, "inlineStyle": { "type": "string", "description": "Inline CSS style applied to the field in the DAM UI." }, "isReadOnly": { "type": "boolean", "description": "When set to true, the field cannot be edited." }, "isRequired": { "type": "boolean", "description": "When set to true, the field is required." }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelModel" }, "description": "Multi-language labels for the name of this field." }, "languageMode": { "type": "string", "description": "Language mode of the field." }, "memberships": { "description": "Field groups this field is a member of. Use AddOrUpdate to add or update members, or Remove to remove them.", "$ref": "#/components/schemas/EditableIdCollectionModel" }, "name": { "type": "string", "description": "Name of the field." }, "scope": { "type": "string", "description": "Scope of the field." }, "sortIndex": { "type": "integer", "description": "Sort index used to order the field relative to other fields.", "format": "int32" }, "tag": { "type": "string", "description": "Tag associated with the field." }, "defaultValue": { "type": "string", "description": "Default value assigned to the field." }, "resetToDefaultTriggers": { "type": "array", "items": { "type": "string" }, "description": "Names of the triggers that reset the field to its default value." }, "resetToDefaultFields": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Ids of the fields that reset this field to its default value when they change." }, "validation": { "type": "string", "description": "Validation expression applied to the field value." }, "validationErrorMessage": { "type": "string", "description": "Error message shown when validation fails." }, "validationTrigger": { "type": "string", "description": "Trigger that determines when validation is applied." }, "storageMode": { "type": "string", "description": "Storage mode of the field." }, "helpTexts": { "type": "array", "items": { "$ref": "#/components/schemas/HelpTextModel" }, "description": "Multi-language help texts for this field." } }, "description": "Command to create a date-time field definition." }, "DateTimeFieldDefinitionResource": { "title": "Date time field definition resource", "type": "object", "properties": { "datePattern": { "type": "string", "description": "The format the field only accepts and returns date values in, when the field stores a date without a time component." }, "dateTimePattern": { "type": "string", "description": "The format the field only accepts and returns date/time values in." }, "useUtc": { "type": "boolean", "description": "Whether auto-generated values for this field are stored in UTC. When true, values are stored and shown in the admin Assets view in UTC, and converted to the requesting user's time zone in the DAM UI." }, "metadataPredictionEnabled": { "type": "boolean", "description": "Indicates whether the field can be predicted by the AI." }, "hints": { "type": "string", "description": "AI Prediction hint for this field." }, "label": { "type": "string", "description": "Label of this field." }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelNonResource" }, "description": "A collection of Label items." }, "dataType": { "$ref": "#/components/schemas/FieldDataType" }, "scope": { "enum": [ "RecordContentGlobal", "RecordContentClassDependent", "RecordContentFloating", "ClassificationProfileClassDependent", "UserGlobal", "FileFileTypeDependent", "FileFloating", "IndexerTaskGlobal", "FileGlobal", "ClassificationProfileFloating", "RecordContentContentTypeDependent" ], "type": "string", "description": "Scope." }, "scopeCategory": { "enum": [ "Record", "File", "Classification", "User", "IndexerTask", "MetadataTemplate" ], "type": "string", "description": "Scope category." }, "indexed": { "type": "boolean", "description": "Indicator if searching on this field is enabled." }, "languageMode": { "enum": [ "Single", "Multiple" ], "type": "string", "description": "Language mode of the field." }, "memberships": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Memberships of a field." }, "searchIndexRebuildRequired": { "type": "boolean", "description": "Indicator if a search index rebuild is required." }, "enabledLanguages": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Enabled languages." }, "id": { "type": "string", "description": "Identifier for this field.", "format": "uuid" }, "name": { "type": "string", "description": "Name for this field." }, "isRequired": { "type": "boolean", "description": "Indicates whether this field is required." }, "isReadOnly": { "type": "boolean", "description": "Indicates whether this field is read only." }, "isUniqueIdentifier": { "type": "boolean", "description": "Indicates whether this field is a unique identifier." }, "inlineStyle": { "type": "string", "description": "Inline CSS style applied to this field." }, "sortIndex": { "type": "integer", "description": "Sorting index of this field.", "format": "int32" }, "tag": { "type": "string", "description": "Tag for this field containing extra information. Opt-in: returned only when requested. Include via a \"select-fielddefinition: Tag\" header." }, "createdOn": { "type": "string", "description": "Created on the specified date in UTC time", "format": "date-time" }, "modifiedOn": { "type": "string", "description": "Modified on the specified date in UTC time", "format": "date-time" }, "defaultValue": { "type": "string", "description": "Default value of this field." }, "resetToDefaultTriggers": { "type": "array", "items": { "enum": [ "None", "OnNewField", "OnLoad", "OnSave", "OnAnyFileChange", "OnReclassifyRecord", "OnAnyChange", "OnFieldChange", "OnMasterFileChange", "OnCurrentFileChange", "OnFieldDefinitionChanged", "OnDuplicateRecord", "OnRecordStatusChange" ], "type": "string" }, "description": "'reset to default triggers' value of this field." }, "validation": { "type": "string", "description": "Validation of this field." }, "validationErrorMessage": { "type": "string", "description": "Error message of this field." }, "validationTrigger": { "enum": [ "None", "WhenNeeded", "Always" ], "type": "string", "description": "Trigger that determines when validation is evaluated for this field." }, "storageMode": { "enum": [ "None", "NonEmptyValues", "AllValues", "LogChanges" ], "type": "string", "description": "Storage mode of this field." }, "resetToDefaultFields": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Fields that trigger this field to be reset back to its default value. This is only used if \"ResetToDefaultTriggers\" is set to \"OnFieldChange\"." }, "helpText": { "type": "string", "description": "Help text of this field." }, "helpTexts": { "type": "array", "items": { "$ref": "#/components/schemas/HelpTextNonResource" }, "description": "A collection of HelpText items." }, "_links": { "type": "object", "properties": { "createdBy": { "description": "Relation to the user who created this field definition.", "$ref": "#/components/schemas/Link" }, "modifiedBy": { "description": "Relation to the user who last modified this field definition.", "$ref": "#/components/schemas/Link" }, "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "createdBy": { "description": "Relation to the user who created this field definition. Embed via a \"select-fielddefinition: createdBy\" header.", "$ref": "#/components/schemas/UserResource" }, "modifiedBy": { "description": "Relation to the user who last modified this field definition. Embed via a \"select-fielddefinition: modifiedBy\" header.", "$ref": "#/components/schemas/UserResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "Representation of the definition of a date/time field" }, "DateTimeFieldRangeFacetModel": { "title": "Date time field range facet model", "type": "object", "properties": { "rangeStart": { "type": [ "null", "string" ], "description": "Start of the range to take into account. Cannot be specified if explicitRanges is specified.", "format": "date-time" }, "rangeEnd": { "type": [ "null", "string" ], "description": "End of the range to take into account. Cannot be specified if explicitRanges is specified.", "format": "date-time" }, "spans": { "type": "array", "items": { "type": "string" }, "description": "Allows for the explicit specification of spans to divide the facet into. If the range specified is larger than the sum of all spans, the last span is repeated to cover the entire range. Cannot be specified if explicitRanges is specified. If spans is specified, rangeStart and rangeEnd are mandatory." }, "boundaries": { "type": "array", "items": { "enum": [ "None", "Lower", "Upper", "Edge", "All" ], "type": "string" }, "description": "Specifies how to include hits that fall on range or span boundaries. Defaults to None." }, "fieldId": { "type": [ "null", "string" ], "description": "The id of the field this facet should operate on.", "format": "uuid" }, "filters": { "type": "array", "items": { "type": "string" }, "description": "Filters allow you to limit the hits returned without affecting facets. If filters are specified, the aggregated counts in the facets remain the same. However, only records that match the filter criteria specified in the facet are returned. The parameter type of the filters depends on the facet type, but is always the same type as explicitValues/explicitRanges." }, "explicitValues": { "type": "array", "items": { "type": "string" }, "description": "A list of values. When specified, only shows facets corresponding to the specified values. If not specified, all occurring values are included." }, "explicitRanges": { "type": "array", "items": { "type": "string" }, "description": "Allows for the explicit specification of ranges to include in the facet. If explicitRanges is specified, you cannot specify rangeStart, rangeEnd, or spans (on the concrete range facet type)." }, "name": { "type": "string", "description": "A textual identifier for this facet, used only by the client to correlate requests with responses." }, "type": { "enum": [ "NumericField", "NumericFieldRange", "Classification", "CreatedBy", "ModifiedBy", "FileType", "OptionListField", "TextField", "DateTimeFieldRange", "DateFieldRange", "CreatedOn", "ModifiedOn", "TimeFieldRange", "TextListField", "ContentType", "ClassificationListField", "DateFieldRangeFilter", "NumericFieldRangeFilter" ], "type": "string", "description": "Type of the facet. Depending on facet type, different parameters, combinations of parameters and parameter types are possible." } }, "description": "A range facet on a DateTime-type field's values." }, "DateTimeFieldResource": { "title": "Date time field resource", "type": "object", "properties": { "dataType": { "$ref": "#/components/schemas/FieldDataType" }, "fieldName": { "type": "string", "description": "Name of this field." }, "label": { "type": "string", "description": "Label of this field." }, "id": { "type": "string", "description": "Id of this field.", "format": "uuid" }, "localizedValues": { "type": "array", "items": { "$ref": "#/components/schemas/DateTimeFieldValue" }, "description": "Language specific data of this field." }, "inheritanceState": { "enum": [ "None", "Inherited" ], "type": [ "null", "string" ], "description": "Inheritance State of this field. Opt-in: returned only when requested. Include via a \"select-field: InheritanceState\" header." }, "inheritable": { "type": [ "null", "boolean" ], "description": "Whether the field value can be used as a parent in inheritance hierarchy. Opt-in: returned only when requested. Include via a \"select-field: Inheritable\" header." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" }, "definition": { "description": "Relation to the field definition.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "definition": { "description": "Relation to the field definition. Embed via a \"select-datetimefield: definition\" header.", "$ref": "#/components/schemas/FieldDefinitionResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "Representation of a DateTimeField" }, "DateTimeFieldValue": { "title": "Date time field value", "type": "object", "properties": { "value": { "type": "string", "description": "DateTime represented as a text in the ISO 8601 format: \"2009-06-15T13:45:30.0000000Z\". Datetime is stored with only 1/300 second precision so to be sure your data is stored at least as serialized, use .ffzzzz format ending" }, "aIInfluenced": { "type": "boolean", "description": "Flag to indicate whether the value has come from AI." }, "languageId": { "type": "string", "description": "The language id.", "format": "uuid" }, "readOnly": { "type": [ "null", "boolean" ], "description": "Tells if the field is read-only." }, "modifiedOn": { "type": "string", "description": "Contains the date/time when the field is last modified.", "format": "date-time" } }, "description": "Language-specific DateTimeField value." }, "DateTimeSettingDefinitionCreateCommand": { "title": "Date time setting definition create command", "type": "object", "properties": { "defaultValue": { "type": "string", "description": "Default value for this date/time setting definition.", "format": "date-time" }, "dataType": { "description": "Data type of the setting definition to create. Determines which additional properties apply.", "$ref": "#/components/schemas/SettingDefinitionType" }, "name": { "type": "string", "description": "Name of this setting definition." }, "categoryId": { "type": "string", "description": "Id of the setting category this setting definition belongs to.", "format": "uuid" }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelModel" }, "description": "Multi-language labels for the name of this setting definition." }, "allowSystemSetting": { "type": "boolean", "description": "When set, allows this setting to be configured at the system level." }, "allowUserSetting": { "type": "boolean", "description": "When set, allows this setting to be configured at the user level." }, "roleRequiredForChange": { "type": "string", "description": "Name of the role required to change settings of this definition." }, "userGroupSettingMode": { "enum": [ "None", "MaximumValue", "MinimumValue", "Manual", "FirstValue" ], "type": "string", "description": "Algorithm used to calculate the effective value for user group settings of this definition." }, "helpUrl": { "type": "string", "description": "URL to help documentation for this setting definition." }, "tag": { "type": "string", "description": "Free-form tag for this setting definition." } }, "description": "Creates a new date/time setting definition." }, "DateTimeSettingDefinitionResource": { "title": "Date time setting definition resource", "type": "object", "properties": { "defaultValue": { "type": "string", "description": "Default value of the setting", "format": "date-time" }, "id": { "type": "string", "description": "Id of the setting definition", "format": "uuid" }, "helpUrl": { "type": "string", "description": "Help url for the setting definition" }, "userGroupSettingMode": { "enum": [ "None", "MaximumValue", "MinimumValue", "Manual", "FirstValue" ], "type": "string", "description": "UserGroupSettingMode for the setting definition" }, "categoryId": { "type": "string", "description": "Category Id for the setting definition", "format": "uuid" }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelNonResource" }, "description": "Collection of labels for the setting definition" }, "allowSystemSetting": { "type": "boolean", "description": "Indicates whether this setting can be configured at the system level." }, "allowUserSetting": { "type": "boolean", "description": "Indicates whether this setting can be configured per user." }, "roleRequiredForChange": { "type": "string", "description": "Role that needs to be changed" }, "name": { "type": "string", "description": "Name of the setting definition" }, "dataType": { "enum": [ "None", "Boolean", "Text", "Numeric", "DateTime", "Xml", "Role", "Reference", "EncryptedText", "DefSchema" ], "type": "string", "description": "Data type of this setting" }, "tag": { "type": "string", "description": "Tag for this setting containing extra information. Opt-in: returned only when requested. Include via a \"select-settingdefinition: Tag\" header." }, "modifiedOn": { "type": "string", "description": "Last modification datetime in UTC time.", "format": "date-time" }, "createdOn": { "type": "string", "description": "Creation datetime in UTC time.", "format": "date-time" }, "_links": { "type": "object", "properties": { "modifiedBy": { "description": "Relation to the user who last modified this settingdefinition.", "$ref": "#/components/schemas/Link" }, "createdBy": { "description": "Relation to the user who created this settingdefinition.", "$ref": "#/components/schemas/Link" }, "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "modifiedBy": { "description": "Relation to the user who last modified this settingdefinition. Embed via a \"select-datetimesettingdefinition: modifiedBy\" header.", "$ref": "#/components/schemas/UserResource" }, "createdBy": { "description": "Relation to the user who created this settingdefinition. Embed via a \"select-datetimesettingdefinition: createdBy\" header.", "$ref": "#/components/schemas/UserResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "Representation of a DateTimeSettingDefinition resource." }, "DefSchemaSettingDefinitionCreateCommand": { "title": "Def schema setting definition create command", "type": "object", "properties": { "defaultValue": { "type": "string", "description": "Default value for this def schema setting definition." }, "schema": { "type": "string", "description": "Def schema used to validate the value of this setting definition." }, "dataType": { "description": "Data type of the setting definition to create. Determines which additional properties apply.", "$ref": "#/components/schemas/SettingDefinitionType" }, "name": { "type": "string", "description": "Name of this setting definition." }, "categoryId": { "type": "string", "description": "Id of the setting category this setting definition belongs to.", "format": "uuid" }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelModel" }, "description": "Multi-language labels for the name of this setting definition." }, "allowSystemSetting": { "type": "boolean", "description": "When set, allows this setting to be configured at the system level." }, "allowUserSetting": { "type": "boolean", "description": "When set, allows this setting to be configured at the user level." }, "roleRequiredForChange": { "type": "string", "description": "Name of the role required to change settings of this definition." }, "userGroupSettingMode": { "enum": [ "None", "MaximumValue", "MinimumValue", "Manual", "FirstValue" ], "type": "string", "description": "Algorithm used to calculate the effective value for user group settings of this definition." }, "helpUrl": { "type": "string", "description": "URL to help documentation for this setting definition." }, "tag": { "type": "string", "description": "Free-form tag for this setting definition." } }, "description": "Creates a new def schema setting definition." }, "DefSchemaSettingDefinitionResource": { "title": "Def schema setting definition resource", "type": "object", "properties": { "defaultValue": { "type": "string", "description": "Default value of the setting" }, "schema": { "type": "string", "description": "Scheme that the field value should match" }, "id": { "type": "string", "description": "Id of the setting definition", "format": "uuid" }, "helpUrl": { "type": "string", "description": "Help url for the setting definition" }, "userGroupSettingMode": { "enum": [ "None", "MaximumValue", "MinimumValue", "Manual", "FirstValue" ], "type": "string", "description": "UserGroupSettingMode for the setting definition" }, "categoryId": { "type": "string", "description": "Category Id for the setting definition", "format": "uuid" }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelNonResource" }, "description": "Collection of labels for the setting definition" }, "allowSystemSetting": { "type": "boolean", "description": "Indicates whether this setting can be configured at the system level." }, "allowUserSetting": { "type": "boolean", "description": "Indicates whether this setting can be configured per user." }, "roleRequiredForChange": { "type": "string", "description": "Role that needs to be changed" }, "name": { "type": "string", "description": "Name of the setting definition" }, "dataType": { "enum": [ "None", "Boolean", "Text", "Numeric", "DateTime", "Xml", "Role", "Reference", "EncryptedText", "DefSchema" ], "type": "string", "description": "Data type of this setting" }, "tag": { "type": "string", "description": "Tag for this setting containing extra information. Opt-in: returned only when requested. Include via a \"select-settingdefinition: Tag\" header." }, "modifiedOn": { "type": "string", "description": "Last modification datetime in UTC time.", "format": "date-time" }, "createdOn": { "type": "string", "description": "Creation datetime in UTC time.", "format": "date-time" }, "_links": { "type": "object", "properties": { "modifiedBy": { "description": "Relation to the user who last modified this settingdefinition.", "$ref": "#/components/schemas/Link" }, "createdBy": { "description": "Relation to the user who created this settingdefinition.", "$ref": "#/components/schemas/Link" }, "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "modifiedBy": { "description": "Relation to the user who last modified this settingdefinition. Embed via a \"select-defschemasettingdefinition: modifiedBy\" header.", "$ref": "#/components/schemas/UserResource" }, "createdBy": { "description": "Relation to the user who created this settingdefinition. Embed via a \"select-defschemasettingdefinition: createdBy\" header.", "$ref": "#/components/schemas/UserResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "Representation of a DefSchemaSettingDefinition resource." }, "DeleteActionParametersModel": { "title": "Delete action parameters model", "type": "object", "properties": { "forceDelete": { "type": "boolean", "description": "When set, bypasses the normal soft-delete/recycle-bin behavior." } }, "description": "Parameters for the \"Delete\" maintenance job action. This action can run with no parameters object at all - ForceDelete defaults to its non-forced behavior when absent." }, "DeletePublicLinksActionParametersModel": { "title": "Delete public links action parameters model", "type": "object", "properties": { "presets": { "type": "array", "items": { "$ref": "#/components/schemas/PublicLinkPresetParametersModel" }, "description": "Presets to delete public links for." } }, "description": "Parameters for the \"DeletePublicLinks\" maintenance job action. At least one preset is required (a runtime check, not enforced by this schema)." }, "DeletePublicUrisRuleActionModel": { "title": "Delete public uris rule action model", "type": "object", "properties": { "presets": { "type": "array", "items": { "$ref": "#/components/schemas/PublicUriPreset" }, "description": "Presets to delete public links for" }, "index": { "type": "integer", "description": "Index of the action within the rule's action collection", "format": "int32" }, "actionType": { "description": "Type of action to be executed.", "$ref": "#/components/schemas/RuleActionDataType" }, "executionTime": { "description": "When the action should be executed.", "$ref": "#/components/schemas/RuleExecutionTime" } }, "description": "Model for DeletePublicLinks rule action" }, "DeletePublicUrisRuleActionNonResource": { "title": "Delete public uris rule action non resource", "type": "object", "properties": { "presets": { "type": "array", "items": { "$ref": "#/components/schemas/PublicUriPreset" }, "description": "Controls which presets will be used." }, "index": { "type": "integer", "description": "Index of a rule action in collection", "format": "int32" }, "actionType": { "description": "Data type of this rule action", "$ref": "#/components/schemas/RuleActionDataType" }, "executionTime": { "description": "Execution time of the rule action", "$ref": "#/components/schemas/RuleExecutionTime" } }, "description": "Representation of the Delete Public URIs rule action, which removes the record's public URIs for the specified presets." }, "DeliveredFileWithAdditionalParameters": { "title": "Delivered file with additional parameters", "type": "object", "properties": { "deliveredPath": { "type": "string", "description": "Path of the delivered file." }, "recordId": { "type": "string", "description": "Id of the Record this delivered file belongs to.", "format": "uuid" }, "renditionName": { "type": "string", "description": "Name of the rendition this delivered file was generated from." }, "status": { "enum": [ "Pending", "Published", "Failed", "Overwritten", "ToBeDeleted" ], "type": "string", "description": "Publish status of the delivered file." } }, "description": "Represents a delivered file together with the additional parameters of the target that produced it." }, "DisableProcessing": { "title": "Disable processing", "enum": [ "No", "Yes", "YesIfPermissionGranted" ], "type": "string", "x-enum-descriptions": [ "", "Disables all file processing and returns a direct link to the original file. Requires the \"Disable file processing of download orders\" permission.", "Returns a direct link to the original file if the user has the required permission granted, and otherwise returns the processed file." ] }, "DisabledKeyword": { "title": "Disabled keyword", "enum": [ "None", "Equals", "NotEquals", "GreaterThan", "GreaterThanOrEqual", "LessThan", "LessThanOrEqual", "In", "Contains", "And", "Or", "Not", "PlusSign", "MinusSign", "QuestionMark", "At", "Dot" ], "type": "string", "x-enum-descriptions": [ "No operators to disable.", "Disables the operator =.", "Disables the operator <>.", "Disables the operator >.", "Disables the operator >=.", "Disables the operator <.", "Disables the operator <=.", "Disables the operator IN.", "Disables the operator CONTAINS.", "Disables the operator AND.", "Disables the operator OR.", "Disables the operator NOT.", "Disables the operator +.", "Disables the operator -.", "Disables the question mark as a special operator.", "Disables the @ character as the escape character for named parameters.", "Disables the . character as an operator, treating it as a normal alphanumeric character." ] }, "DownloadAgreementClassificationCollection": { "title": "Download agreement classification collection", "type": "object", "properties": { "addOrUpdate": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Ids of the classifications to add." }, "remove": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Ids of the classifications to remove." } }, "description": "Classifications associated with a download agreement." }, "DownloadAgreementClassificationCollectionResource": { "title": "Download agreement classification collection resource", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/DownloadAgreementClassificationResource" }, "description": "A collection of resource items." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of a non-paged collection of download agreement classifications" }, "DownloadAgreementClassificationResource": { "title": "Download agreement classification resource", "type": "object", "properties": { "id": { "type": "string", "description": "Id of this classification.", "format": "uuid" }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" }, "target": { "description": "Relation to the target classification.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "target": { "description": "Relation to the target classification. Embed via a \"select-downloadagreementclassification: target\" header.", "$ref": "#/components/schemas/ClassificationResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "Representation of download agreement's classification" }, "DownloadAgreementContentCollection": { "title": "Download agreement content collection", "type": "object", "properties": { "addOrUpdate": { "type": "array", "items": { "$ref": "#/components/schemas/DownloadAgreementContentModel" }, "description": "Content items to add or update." } }, "description": "Content items associated with a download agreement." }, "DownloadAgreementContentCollectionResource": { "title": "Download agreement content collection resource", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/DownloadAgreementContentResource" }, "description": "A collection of non-resource items." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of a collection of download agreement's content" }, "DownloadAgreementContentModel": { "title": "Download agreement content model", "type": "object", "properties": { "languageId": { "type": "string", "description": "Id of the language this content applies to.", "format": "uuid" }, "title": { "type": "string", "description": "Title of the download agreement in this language." }, "termsOfUse": { "type": "string", "description": "Terms of use of the download agreement in this language." } }, "description": "Language-specific content of a download agreement." }, "DownloadAgreementContentResource": { "title": "Download agreement content resource", "type": "object", "properties": { "id": { "type": "integer", "description": "Id of this download agreement's content.", "format": "int32" }, "languageId": { "type": "string", "description": "Language Id on which this download agreement's content is for", "format": "uuid" }, "version": { "type": "integer", "description": "Version of the download agreement content", "format": "int32" }, "title": { "type": "string", "description": "Download agreement's content title" }, "termsOfUse": { "type": "string", "description": "Terms of use for download agreement content" }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "The localized title and terms-of-use text for a download agreement, versioned per language - the actual text a user reads and accepts." }, "DownloadAgreementCreateCommand": { "title": "Download agreement create command", "type": "object", "properties": { "enabled": { "type": "boolean", "description": "When set to true, the download agreement is enabled." }, "contents": { "description": "Content items covered by this download agreement. Use Contents.AddOrUpdate to add new content or replace the entire collection.", "$ref": "#/components/schemas/DownloadAgreementContentCollection" }, "userGroups": { "description": "User groups this download agreement applies to. Use UserGroups.AddOrUpdate to add or update members, or UserGroups.Remove to remove them.", "$ref": "#/components/schemas/DownloadAgreementUserGroupCollection" }, "classifications": { "description": "Classifications this download agreement applies to. Use Classifications.AddOrUpdate to add or update members, or Classifications.Remove to remove them.", "$ref": "#/components/schemas/DownloadAgreementClassificationCollection" } }, "description": "Command to create a new download agreement." }, "DownloadAgreementEditCommand": { "title": "Download agreement edit command", "type": "object", "properties": { "enabled": { "type": "boolean", "description": "When set to true, the download agreement is enabled." }, "contents": { "description": "Content items covered by this download agreement. Use Contents.AddOrUpdate to add new content or replace the entire collection.", "$ref": "#/components/schemas/DownloadAgreementContentCollection" }, "userGroups": { "description": "User groups this download agreement applies to. Use UserGroups.AddOrUpdate to add or update members, or UserGroups.Remove to remove them.", "$ref": "#/components/schemas/DownloadAgreementUserGroupCollection" }, "classifications": { "description": "Classifications this download agreement applies to. Use Classifications.AddOrUpdate to add or update members, or Classifications.Remove to remove them.", "$ref": "#/components/schemas/DownloadAgreementClassificationCollection" } }, "description": "Command to update an existing download agreement." }, "DownloadAgreementPagedCollectionResource": { "title": "Download agreement paged collection resource", "type": "object", "properties": { "pageNumber": { "type": [ "null", "integer" ], "description": "The current page of this paged collection.", "format": "int32" }, "pageSize": { "type": [ "null", "integer" ], "description": "The current page size of this paged collection.", "format": "int32" }, "skip": { "type": [ "null", "integer" ], "description": "The current skip size of this paged collection.", "format": "int32" }, "take": { "type": [ "null", "integer" ], "description": "The current take size of this paged collection.", "format": "int32" }, "totalCount": { "type": "integer", "description": "The total count of items in this paged collection, not just on the current page.", "format": "int64" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/DownloadAgreementResource" }, "description": "One page of this paged collection, which is a subcollection of the complete collection." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" }, "first": { "description": "A link to the first page of this paged collection.", "$ref": "#/components/schemas/Link" }, "prev": { "description": "A link to the previous page of this paged collection.", "$ref": "#/components/schemas/Link" }, "next": { "description": "A link to the next page of this paged collection.", "$ref": "#/components/schemas/Link" }, "last": { "description": "A link to the last page of this paged collection.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of a paged collection of download agreements" }, "DownloadAgreementResource": { "title": "Download agreement resource", "type": "object", "properties": { "id": { "type": "integer", "description": "Id of this download agreement.", "format": "int32" }, "enabled": { "type": "boolean", "description": "Is the download agreement enabled." }, "createdOn": { "type": "string", "description": "Creation datetime in UTC time.", "format": "date-time" }, "modifiedOn": { "type": "string", "description": "Last modification datetime in UTC time.", "format": "date-time" }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" }, "contents": { "description": "Relation to the contents of this DownloadAgreement.", "$ref": "#/components/schemas/Link" }, "userGroups": { "description": "Relation to the user groups of this download agreement.", "$ref": "#/components/schemas/Link" }, "classifications": { "description": "Relation to a collection of download agreement classifications.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "contents": { "description": "Relation to the contents of this DownloadAgreement. Embed via a \"select-downloadagreement: contents\" header.", "$ref": "#/components/schemas/DownloadAgreementContentCollectionResource" }, "userGroups": { "description": "Relation to the user groups of this download agreement. Embed via a \"select-downloadagreement: userGroups\" header.", "$ref": "#/components/schemas/DownloadAgreementUserGroupCollectionResource" }, "classifications": { "description": "Relation to a collection of download agreement classifications. Embed via a \"select-downloadagreement: classifications\" header.", "$ref": "#/components/schemas/DownloadAgreementClassificationCollectionResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "A policy that users must accept before they can download content." }, "DownloadAgreementUserGroupCollection": { "title": "Download agreement user group collection", "type": "object", "properties": { "addOrUpdate": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Ids of the user groups to add." }, "remove": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Ids of the user groups to remove." } }, "description": "User groups associated with a download agreement." }, "DownloadAgreementUserGroupCollectionResource": { "title": "Download agreement user group collection resource", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/DownloadAgreementUserGroupResource" }, "description": "A collection of resource items." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Collection of applicable download agreement's user groups" }, "DownloadAgreementUserGroupResource": { "title": "Download agreement user group resource", "type": "object", "properties": { "id": { "type": "string", "description": "Id of this user group.", "format": "uuid" }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" }, "target": { "description": "Relation to the target user group.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "target": { "description": "Relation to the target user group. Embed via a \"select-downloadagreementusergroup: target\" header.", "$ref": "#/components/schemas/UserGroupResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "Representation of download agreement's user group" }, "DownloadContactSheetResource": { "title": "Download contact sheet resource", "type": "object", "properties": { "notificationThresholdInSeconds": { "type": [ "null", "integer" ], "description": "The threshold in seconds that must elapse to be able to send an email notification.", "format": "int32" }, "useCDN": { "description": "Allows overriding the default file path behaviour. Set this parameter to 'No' if you need to use the file in the same Azure region and don't need to benefit from the CDN.", "$ref": "#/components/schemas/UseCDN" }, "orderType": { "type": "string", "description": "Type of the order" }, "deliveredFiles": { "type": "array", "items": { "type": "string" }, "description": "The files delivered to the client by this order." }, "totalFileSize": { "type": "integer", "description": "Total file size of the delivered files", "format": "int64" }, "creatorEmail": { "type": "string", "description": "E-mail address for this job" }, "disableNotification": { "type": "boolean", "description": "Value indicating whether or not notification is enabled on this job" }, "earliestStartDate": { "type": [ "null", "string" ], "description": "The earliest date in utc time on which this job can be executed.", "format": "date-time" }, "executionTime": { "type": "string", "description": "Time it took for this maintenance job to execute." }, "id": { "type": "string", "description": "Id of this maintenance job.", "format": "uuid" }, "type": { "type": "string", "description": "Name of this maintenance job." }, "priority": { "enum": [ "High", "Medium", "AuditArchiving", "BuildSearchIndex" ], "type": "string", "description": "Priority of this maintenance job." }, "startedOn": { "type": [ "null", "string" ], "description": "Time on which the execution of this maintenance job started in utc time.", "format": "date-time" }, "status": { "enum": [ "Pending", "Success", "Failed", "PartiallyFailed", "Executing", "Cancelled", "Scheduled", "Queued", "AsyncPending", "AsyncExecuting" ], "type": "string", "description": "Status of this maintenance job." }, "message": { "type": [ "null", "string" ], "description": "Error message that describes why this maintenance job failed. Returns null if this maintenance job hasn't been executed yet." }, "failedTargetsCount": { "type": "integer", "description": "Count of the failed targets.", "format": "int32" }, "createdOn": { "type": "string", "description": "Creation datetime in UTC time.", "format": "date-time" }, "_links": { "type": "object", "properties": { "targets": { "description": "Relation to a collection of order targets.", "$ref": "#/components/schemas/Link" }, "createdBy": { "description": "Relation to the user who created this maintenance job.", "$ref": "#/components/schemas/Link" }, "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "targets": { "description": "Relation to a collection of order targets. Embed via a \"select-order: targets\" header.", "$ref": "#/components/schemas/OrderTargetCollectionResource" }, "createdBy": { "description": "Relation to the user who created this maintenance job. Embed via a \"select-downloadcontactsheet: createdBy\" header.", "$ref": "#/components/schemas/UserResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "Representation of Contact Sheet during download." }, "DownloadLinkMassOrderTargetError": { "title": "Download link mass order target error", "type": "object", "properties": { "errorDescription": { "type": "string", "description": "Value for the error description of this object." }, "recordIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Value for the record ids of this object." } }, "description": "Representation of an error for a target error group, along with the record ids affected by that error." }, "DownloadLinkPagedCollectionResource": { "title": "Download link paged collection resource", "type": "object", "properties": { "pageNumber": { "type": [ "null", "integer" ], "description": "The current page of this paged collection.", "format": "int32" }, "pageSize": { "type": [ "null", "integer" ], "description": "The current page size of this paged collection.", "format": "int32" }, "skip": { "type": [ "null", "integer" ], "description": "The current skip size of this paged collection.", "format": "int32" }, "take": { "type": [ "null", "integer" ], "description": "The current take size of this paged collection.", "format": "int32" }, "totalCount": { "type": "integer", "description": "The total count of items in this paged collection, not just on the current page.", "format": "int64" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/DownloadLinkResource" }, "description": "One page of this paged collection, which is a subcollection of the complete collection." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" }, "first": { "description": "A link to the first page of this paged collection.", "$ref": "#/components/schemas/Link" }, "prev": { "description": "A link to the previous page of this paged collection.", "$ref": "#/components/schemas/Link" }, "next": { "description": "A link to the next page of this paged collection.", "$ref": "#/components/schemas/Link" }, "last": { "description": "A link to the last page of this paged collection.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "This page describes how you can get a paged collection of download links (output from maintenance jobs) that users have created. There are 4 types of download links corresponding with the maintenance job type they originate from: download orders, metadata exports, contact sheets, and audit exports." }, "DownloadLinkResource": { "title": "Download link resource", "type": "object", "properties": { "id": { "type": "string", "description": "Id of this maintenance job", "format": "uuid" }, "type": { "type": "string", "description": "Type of download link" }, "status": { "enum": [ "Pending", "Success", "Failed", "PartiallyFailed", "Executing", "Cancelled", "Scheduled", "Queued", "AsyncPending", "AsyncExecuting" ], "type": "string", "description": "Status of this download link" }, "title": { "type": "string", "description": "Title of a download link" }, "description": { "type": "string", "description": "Description of a download link" }, "errorDescription": { "type": "string", "description": "Get the user friendly error description from download link" }, "deliveredFiles": { "type": "array", "items": { "type": "string" }, "description": "List of download links to the files generated by the order or maintenance job." }, "failedTargetsCount": { "type": "integer", "description": "Count of failed targets.", "format": "int32" }, "succeededRecordsCount": { "type": "integer", "description": "Count of records for which all requested files were successfully processed.", "format": "int32" }, "failedRecordsCount": { "type": "integer", "description": "Count of records for which there were errors when processing of any requested files.", "format": "int32" }, "downloadAgreementIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Ids of download agreements, if any applicable to any record in download" }, "createdOn": { "type": "string", "description": "Creation datetime in UTC time.", "format": "date-time" }, "_links": { "type": "object", "properties": { "targets": { "description": "Relation to a collection of download targets.", "$ref": "#/components/schemas/Link" }, "createdBy": { "description": "Relation to the user who created this download link.", "$ref": "#/components/schemas/Link" }, "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "targets": { "description": "Relation to a collection of download targets. Embed via a \"select-downloadlink: targets\" header.", "$ref": "#/components/schemas/DownloadLinkTargetCollectionResource" }, "createdBy": { "description": "Relation to the user who created this download link. Embed via a \"select-downloadlink: createdBy\" header.", "$ref": "#/components/schemas/UserResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "The result of a maintenance job that generates downloadable files (e.g. a download order, export, or contact sheet), including its status, generated files, and any download agreements that apply." }, "DownloadLinkTargetCollectionResource": { "title": "Download link target collection resource", "type": "object", "properties": { "items": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/ExportAuditDownloadLinkTargetResource" }, { "$ref": "#/components/schemas/ExportMetadataDownloadLinkTargetResource" }, { "$ref": "#/components/schemas/OrderDownloadLinkTargetResource" }, { "$ref": "#/components/schemas/OrderDownloadLinkMassTargetResource" } ] }, "description": "A collection of resource items." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "A collection of download link targets." }, "DownloadOrderCreateCommand": { "title": "Download order create command", "type": "object", "properties": { "singleFileZipMode": { "type": "string", "description": "Controls whether a single file is delivered as-is or wrapped in a zip archive: \"Never\", \"Always\", or \"WhenNeeded\" (zips only when the chosen delivery target needs a directory structure that it can't otherwise represent, e.g. ordering all items of a publication)." }, "downloadsPageUrl": { "type": "string", "description": "URL of the page where the download can be retrieved." }, "notificationThresholdInSeconds": { "type": [ "null", "integer" ], "description": "Number of seconds after which a notification is sent if the order has not completed.", "format": "int32" }, "useCDN": { "type": "string", "description": "Controls whether the download is served through the CDN." }, "deliveryLocation": { "type": "string", "description": "Location where the order output is delivered." }, "includeTargets": { "type": "boolean", "description": "When set, includes the resolved order targets in the response." }, "disableProcessing": { "type": "string", "description": "When set, disables further processing of the order." }, "creatorEmail": { "type": "string", "description": "Email address of the user the job is created on behalf of." }, "disableNotification": { "type": "boolean", "description": "When set to true, suppresses notifications for this job." }, "earliestStartDate": { "type": [ "null", "string" ], "description": "Earliest date and time at which the job is allowed to start executing.", "format": "date-time" }, "priority": { "enum": [ "High", "Medium" ], "type": "string", "description": "Priority used to schedule this job relative to other maintenance jobs." }, "type": { "enum": [ "Classification", "Record", "ExportAuditTrail", "BulkRecord", "AcceptDownloadOrderAgreement", "BulkCollection", "ExportContentItemsList" ], "type": "string", "description": "Type of maintenance job to create." }, "targets": { "type": "array", "items": { "$ref": "#/components/schemas/OrderTargetModel" }, "description": "Targets the job's actions are applied to." }, "actions": { "type": "array", "items": { "$ref": "#/components/schemas/ActionModel" }, "description": "Actions to execute for each target of this job." }, "title": { "type": "string", "description": "Title of the job. For a download or contact-sheet order this is shown on the Downloads page in Content Workspace; if omitted, it defaults to the file name, or \"X items\" when multiple files were ordered. Either plain text, or a JSON string of the form {\"studioName\":\"...\",\"moduleName\":\"...\",\"translationKey\":\"...\"} to look up a translated value for non-English users (see the Localization > Translations section of the DAM Administrator Guide for how translations are registered)." }, "description": { "type": "string", "description": "Description of the job. For a download or contact-sheet order this is shown on the Downloads page in Content Workspace; if omitted, it defaults to \"Download\". Accepts the same plain-text-or-translation-key JSON format as Title." }, "errorMode": { "type": "string", "description": "Determines how the job behaves when one of its targets fails to execute." } }, "description": "Payload for creating an order that packages records into a downloadable archive." }, "DownloadOrderResource": { "title": "Download order resource", "type": "object", "properties": { "notificationThresholdInSeconds": { "type": [ "null", "integer" ], "description": "The threshold in seconds that must elapse to be able to send an email notification", "format": "int32" }, "useCDN": { "description": "Allows overriding the default file path behaviour. Set this parameter to 'No' if you need to use the file in the same Azure region, and don't need to benefit from CDN.", "$ref": "#/components/schemas/UseCDN" }, "disableProcessing": { "description": "Allows overriding the default post-processing behaviour. Set this parameter to 'Yes' to disable all file processing (eg. XMP writeback, watermarks being applied, order target actions) and allows getting a direct link to the original file. The user permission \"Disable file processing of download orders\" is required for this order to work. Setting the parameter to 'YesIfPermissionGranted' will return a direct link if the user has the permission granted, and otherwise return the processed file.", "$ref": "#/components/schemas/DisableProcessing" }, "downloadAgreementIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Represents an array of integers that stores the Ids of download agreements." }, "orderType": { "type": "string", "description": "Type of the order" }, "deliveredFiles": { "type": "array", "items": { "type": "string" }, "description": "The files delivered to the client by this order." }, "totalFileSize": { "type": "integer", "description": "Total file size of the delivered files", "format": "int64" }, "creatorEmail": { "type": "string", "description": "E-mail address for this job" }, "disableNotification": { "type": "boolean", "description": "Value indicating whether or not notification is enabled on this job" }, "earliestStartDate": { "type": [ "null", "string" ], "description": "The earliest date in utc time on which this job can be executed.", "format": "date-time" }, "executionTime": { "type": "string", "description": "Time it took for this maintenance job to execute." }, "id": { "type": "string", "description": "Id of this maintenance job.", "format": "uuid" }, "type": { "type": "string", "description": "Name of this maintenance job." }, "priority": { "enum": [ "High", "Medium", "AuditArchiving", "BuildSearchIndex" ], "type": "string", "description": "Priority of this maintenance job." }, "startedOn": { "type": [ "null", "string" ], "description": "Time on which the execution of this maintenance job started in utc time.", "format": "date-time" }, "status": { "enum": [ "Pending", "Success", "Failed", "PartiallyFailed", "Executing", "Cancelled", "Scheduled", "Queued", "AsyncPending", "AsyncExecuting" ], "type": "string", "description": "Status of this maintenance job." }, "message": { "type": [ "null", "string" ], "description": "Error message that describes why this maintenance job failed. Returns null if this maintenance job hasn't been executed yet." }, "failedTargetsCount": { "type": "integer", "description": "Count of the failed targets.", "format": "int32" }, "createdOn": { "type": "string", "description": "Creation datetime in UTC time.", "format": "date-time" }, "_links": { "type": "object", "properties": { "targets": { "description": "Relation to a collection of order targets.", "$ref": "#/components/schemas/Link" }, "createdBy": { "description": "Relation to the user who created this maintenance job.", "$ref": "#/components/schemas/Link" }, "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "targets": { "description": "Relation to a collection of order targets. Embed via a \"select-order: targets\" header.", "$ref": "#/components/schemas/OrderTargetCollectionResource" }, "createdBy": { "description": "Relation to the user who created this maintenance job. Embed via a \"select-downloadorder: createdBy\" header.", "$ref": "#/components/schemas/UserResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "Representation of a download order." }, "DownloadPermissionModel": { "title": "Download permission model", "type": "object", "properties": { "userGroupId": { "type": [ "null", "string" ], "description": "Identifier of the user group this permission applies to.", "format": "uuid" }, "accessRight": { "enum": [ "NoAccess", "Allow", "Deny", "Inherit" ], "type": [ "null", "string" ], "description": "Download access right granted to the user group." }, "id": { "type": "string", "description": "Identifier used to match this entry, equal to UserGroupId.", "format": "uuid" } }, "description": "Download permission granted to a user group on a classification." }, "DownloadPermissionsModel": { "title": "Download permissions model", "type": "object", "properties": { "addOrUpdate": { "type": "array", "items": { "$ref": "#/components/schemas/DownloadPermissionModel" }, "description": "Download permissions to add or update." }, "remove": { "type": "array", "items": { "$ref": "#/components/schemas/DownloadPermissionModel" }, "description": "Download permissions to remove." } }, "description": "Collection of download permissions to add, update, or remove." }, "DownloadRight": { "title": "Download right", "enum": [ "NoAccess", "Allow", "Deny", "Inherit" ], "type": "string" }, "Duplicate": { "title": "Duplicate", "type": "object", "properties": { "reason": { "enum": [ "FileNameAndContent", "FileName", "FileContent" ], "type": "string", "description": "Reason why the file version was detected as a duplicate." }, "recordId": { "type": "string", "description": "Id of the record the duplicate file version belongs to.", "format": "uuid" }, "fileVersionId": { "type": "string", "description": "Id of the duplicate file version.", "format": "uuid" } }, "description": "Representation of a file version that was detected as a duplicate." }, "DuplicateStatus": { "title": "Duplicate status", "enum": [ "Undetermined", "NoDuplicate", "Duplicate" ], "type": "string", "x-enum-descriptions": [ "Duplicate detection has not yet determined whether this file version is a duplicate.", "The file version is not a duplicate of any other file version.", "The file version is a duplicate of one or more other file versions." ] }, "DurationFieldDefinitionCreateCommand": { "title": "Duration field definition create command", "type": "object", "properties": { "dataType": { "description": "Data type of the field definition. Determines which other properties apply.", "$ref": "#/components/schemas/FieldDefinitionType" }, "enabledLanguages": { "description": "Languages in which this field is enabled. Use AddOrUpdate to add or update members, or Remove to remove them.", "$ref": "#/components/schemas/EditableIdCollectionModel" }, "indexed": { "type": "boolean", "description": "When set to true, the field is indexed for search." }, "inlineStyle": { "type": "string", "description": "Inline CSS style applied to the field in the DAM UI." }, "isReadOnly": { "type": "boolean", "description": "When set to true, the field cannot be edited." }, "isRequired": { "type": "boolean", "description": "When set to true, the field is required." }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelModel" }, "description": "Multi-language labels for the name of this field." }, "languageMode": { "type": "string", "description": "Language mode of the field." }, "memberships": { "description": "Field groups this field is a member of. Use AddOrUpdate to add or update members, or Remove to remove them.", "$ref": "#/components/schemas/EditableIdCollectionModel" }, "name": { "type": "string", "description": "Name of the field." }, "scope": { "type": "string", "description": "Scope of the field." }, "sortIndex": { "type": "integer", "description": "Sort index used to order the field relative to other fields.", "format": "int32" }, "tag": { "type": "string", "description": "Tag associated with the field." }, "defaultValue": { "type": "string", "description": "Default value assigned to the field." }, "resetToDefaultTriggers": { "type": "array", "items": { "type": "string" }, "description": "Names of the triggers that reset the field to its default value." }, "resetToDefaultFields": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Ids of the fields that reset this field to its default value when they change." }, "validation": { "type": "string", "description": "Validation expression applied to the field value." }, "validationErrorMessage": { "type": "string", "description": "Error message shown when validation fails." }, "validationTrigger": { "type": "string", "description": "Trigger that determines when validation is applied." }, "storageMode": { "type": "string", "description": "Storage mode of the field." }, "helpTexts": { "type": "array", "items": { "$ref": "#/components/schemas/HelpTextModel" }, "description": "Multi-language help texts for this field." } }, "description": "Command to create a duration field definition." }, "DurationFieldDefinitionResource": { "title": "Duration field definition resource", "type": "object", "properties": { "label": { "type": "string", "description": "Label of this field." }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelNonResource" }, "description": "A collection of Label items." }, "dataType": { "$ref": "#/components/schemas/FieldDataType" }, "scope": { "enum": [ "RecordContentGlobal", "RecordContentClassDependent", "RecordContentFloating", "ClassificationProfileClassDependent", "UserGlobal", "FileFileTypeDependent", "FileFloating", "IndexerTaskGlobal", "FileGlobal", "ClassificationProfileFloating", "RecordContentContentTypeDependent" ], "type": "string", "description": "Scope." }, "scopeCategory": { "enum": [ "Record", "File", "Classification", "User", "IndexerTask", "MetadataTemplate" ], "type": "string", "description": "Scope category." }, "indexed": { "type": "boolean", "description": "Indicator if searching on this field is enabled." }, "languageMode": { "enum": [ "Single", "Multiple" ], "type": "string", "description": "Language mode of the field." }, "memberships": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Memberships of a field." }, "searchIndexRebuildRequired": { "type": "boolean", "description": "Indicator if a search index rebuild is required." }, "enabledLanguages": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Enabled languages." }, "id": { "type": "string", "description": "Identifier for this field.", "format": "uuid" }, "name": { "type": "string", "description": "Name for this field." }, "isRequired": { "type": "boolean", "description": "Indicates whether this field is required." }, "isReadOnly": { "type": "boolean", "description": "Indicates whether this field is read only." }, "isUniqueIdentifier": { "type": "boolean", "description": "Indicates whether this field is a unique identifier." }, "inlineStyle": { "type": "string", "description": "Inline CSS style applied to this field." }, "sortIndex": { "type": "integer", "description": "Sorting index of this field.", "format": "int32" }, "tag": { "type": "string", "description": "Tag for this field containing extra information. Opt-in: returned only when requested. Include via a \"select-fielddefinition: Tag\" header." }, "createdOn": { "type": "string", "description": "Created on the specified date in UTC time", "format": "date-time" }, "modifiedOn": { "type": "string", "description": "Modified on the specified date in UTC time", "format": "date-time" }, "defaultValue": { "type": "string", "description": "Default value of this field." }, "resetToDefaultTriggers": { "type": "array", "items": { "enum": [ "None", "OnNewField", "OnLoad", "OnSave", "OnAnyFileChange", "OnReclassifyRecord", "OnAnyChange", "OnFieldChange", "OnMasterFileChange", "OnCurrentFileChange", "OnFieldDefinitionChanged", "OnDuplicateRecord", "OnRecordStatusChange" ], "type": "string" }, "description": "'reset to default triggers' value of this field." }, "validation": { "type": "string", "description": "Validation of this field." }, "validationErrorMessage": { "type": "string", "description": "Error message of this field." }, "validationTrigger": { "enum": [ "None", "WhenNeeded", "Always" ], "type": "string", "description": "Trigger that determines when validation is evaluated for this field." }, "storageMode": { "enum": [ "None", "NonEmptyValues", "AllValues", "LogChanges" ], "type": "string", "description": "Storage mode of this field." }, "resetToDefaultFields": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Fields that trigger this field to be reset back to its default value. This is only used if \"ResetToDefaultTriggers\" is set to \"OnFieldChange\"." }, "helpText": { "type": "string", "description": "Help text of this field." }, "helpTexts": { "type": "array", "items": { "$ref": "#/components/schemas/HelpTextNonResource" }, "description": "A collection of HelpText items." }, "_links": { "type": "object", "properties": { "createdBy": { "description": "Relation to the user who created this field definition.", "$ref": "#/components/schemas/Link" }, "modifiedBy": { "description": "Relation to the user who last modified this field definition.", "$ref": "#/components/schemas/Link" }, "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "createdBy": { "description": "Relation to the user who created this field definition. Embed via a \"select-fielddefinition: createdBy\" header.", "$ref": "#/components/schemas/UserResource" }, "modifiedBy": { "description": "Relation to the user who last modified this field definition. Embed via a \"select-fielddefinition: modifiedBy\" header.", "$ref": "#/components/schemas/UserResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "Representation of the definition of a duration field" }, "DurationFieldResource": { "title": "Duration field resource", "type": "object", "properties": { "dataType": { "$ref": "#/components/schemas/FieldDataType" }, "fieldName": { "type": "string", "description": "Name of this field." }, "label": { "type": "string", "description": "Label of this field." }, "id": { "type": "string", "description": "Id of this field.", "format": "uuid" }, "localizedValues": { "type": "array", "items": { "$ref": "#/components/schemas/DurationFieldValue" }, "description": "Language specific data of this field." }, "inheritanceState": { "enum": [ "None", "Inherited" ], "type": [ "null", "string" ], "description": "Inheritance State of this field. Opt-in: returned only when requested. Include via a \"select-field: InheritanceState\" header." }, "inheritable": { "type": [ "null", "boolean" ], "description": "Whether the field value can be used as a parent in inheritance hierarchy. Opt-in: returned only when requested. Include via a \"select-field: Inheritable\" header." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" }, "definition": { "description": "Relation to the field definition.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "definition": { "description": "Relation to the field definition. Embed via a \"select-durationfield: definition\" header.", "$ref": "#/components/schemas/FieldDefinitionResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "Representation of a DurationField" }, "DurationFieldValue": { "title": "Duration field value", "type": "object", "properties": { "value": { "type": "string", "description": "Duration represented as a text in the following format: \"[-][d.]hh:mm:ss[.fffffff]\"." }, "languageId": { "type": "string", "description": "The language id.", "format": "uuid" }, "readOnly": { "type": [ "null", "boolean" ], "description": "Tells if the field is read-only." }, "modifiedOn": { "type": "string", "description": "Contains the date/time when the field is last modified.", "format": "date-time" } }, "description": "Language-specific DurationField value." }, "EditRecordResource": { "title": "Edit record resource", "type": "object", "properties": { "token": { "type": "string", "description": "The token representing the edit session", "format": "uuid" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ValidationErrorResource" }, "description": "The validation errors if any" }, "_links": { "type": "object", "properties": { "record": { "description": "The record resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "A resource representing an edit session containing the Record and the edit token Use the returned token to apply further changes on the edit session" }, "EditSharedDownloadLinkExpirationCommand": { "title": "Edit shared download link expiration command", "type": "object", "properties": { "sharedDownloadLinkId": { "type": "string", "format": "uuid" }, "expiresOn": { "type": "string", "description": "The new expiration date, in UTC. Must be in the future and must not push the link's total lifetime beyond its maximum from the original creation date.", "format": "date-time" } } }, "EditableIdCollectionModel": { "title": "Editable id collection model", "type": "object", "properties": { "addOrUpdate": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs to add." }, "remove": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs to remove." } }, "description": "Collection of IDs to add or remove." }, "EditableStringIdCollectionModel": { "title": "Editable string id collection model", "type": "object", "properties": { "addOrUpdate": { "type": "array", "items": { "type": "string" }, "description": "IDs to add." }, "remove": { "type": "array", "items": { "type": "string" }, "description": "IDs to remove." } }, "description": "Collection of string IDs to add or remove." }, "EmailOrderCreateCommand": { "title": "Email order create command", "type": "object", "properties": { "emailRecipients": { "type": "array", "items": { "type": "string" }, "description": "Email addresses that receive the notification." }, "emailSubject": { "type": "string", "description": "Subject line of the notification email." }, "emailBody": { "type": "string", "description": "Body text of the notification email." }, "resolvePackages": { "type": "boolean", "description": "When set, resolves packages before delivering the order." }, "downloadAgreementContentId": { "type": "integer", "description": "Id of the download agreement content that recipients must accept before downloading.", "format": "int32" }, "deliveryLocation": { "type": "string", "description": "Location where the order output is delivered." }, "includeTargets": { "type": "boolean", "description": "When set, includes the resolved order targets in the response." }, "disableProcessing": { "type": "string", "description": "When set, disables further processing of the order." }, "creatorEmail": { "type": "string", "description": "Email address of the user the job is created on behalf of." }, "disableNotification": { "type": "boolean", "description": "When set to true, suppresses notifications for this job." }, "earliestStartDate": { "type": [ "null", "string" ], "description": "Earliest date and time at which the job is allowed to start executing.", "format": "date-time" }, "priority": { "enum": [ "High", "Medium" ], "type": "string", "description": "Priority used to schedule this job relative to other maintenance jobs." }, "type": { "enum": [ "Classification", "Record", "ExportAuditTrail", "BulkRecord", "AcceptDownloadOrderAgreement", "BulkCollection", "ExportContentItemsList" ], "type": "string", "description": "Type of maintenance job to create." }, "targets": { "type": "array", "items": { "$ref": "#/components/schemas/OrderTargetModel" }, "description": "Targets the job's actions are applied to." }, "actions": { "type": "array", "items": { "$ref": "#/components/schemas/ActionModel" }, "description": "Actions to execute for each target of this job." }, "title": { "type": "string", "description": "Title of the job. For a download or contact-sheet order this is shown on the Downloads page in Content Workspace; if omitted, it defaults to the file name, or \"X items\" when multiple files were ordered. Either plain text, or a JSON string of the form {\"studioName\":\"...\",\"moduleName\":\"...\",\"translationKey\":\"...\"} to look up a translated value for non-English users (see the Localization > Translations section of the DAM Administrator Guide for how translations are registered)." }, "description": { "type": "string", "description": "Description of the job. For a download or contact-sheet order this is shown on the Downloads page in Content Workspace; if omitted, it defaults to \"Download\". Accepts the same plain-text-or-translation-key JSON format as Title." }, "errorMode": { "type": "string", "description": "Determines how the job behaves when one of its targets fails to execute." } }, "description": "Payload for creating an order that emails a link to the order output." }, "EmailOrderResource": { "title": "Email order resource", "type": "object", "properties": { "emailRecipients": { "type": "array", "items": { "type": "string" }, "description": "The recipients to send the mail to" }, "emailSubject": { "type": "string", "description": "The subject of the mail" }, "emailBody": { "type": "string", "description": "The body of the mail" }, "orderType": { "type": "string", "description": "Type of the order" }, "deliveredFiles": { "type": "array", "items": { "type": "string" }, "description": "The files delivered to the client by this order." }, "totalFileSize": { "type": "integer", "description": "Total file size of the delivered files", "format": "int64" }, "creatorEmail": { "type": "string", "description": "E-mail address for this job" }, "disableNotification": { "type": "boolean", "description": "Value indicating whether or not notification is enabled on this job" }, "earliestStartDate": { "type": [ "null", "string" ], "description": "The earliest date in utc time on which this job can be executed.", "format": "date-time" }, "executionTime": { "type": "string", "description": "Time it took for this maintenance job to execute." }, "id": { "type": "string", "description": "Id of this maintenance job.", "format": "uuid" }, "type": { "type": "string", "description": "Name of this maintenance job." }, "priority": { "enum": [ "High", "Medium", "AuditArchiving", "BuildSearchIndex" ], "type": "string", "description": "Priority of this maintenance job." }, "startedOn": { "type": [ "null", "string" ], "description": "Time on which the execution of this maintenance job started in utc time.", "format": "date-time" }, "status": { "enum": [ "Pending", "Success", "Failed", "PartiallyFailed", "Executing", "Cancelled", "Scheduled", "Queued", "AsyncPending", "AsyncExecuting" ], "type": "string", "description": "Status of this maintenance job." }, "message": { "type": [ "null", "string" ], "description": "Error message that describes why this maintenance job failed. Returns null if this maintenance job hasn't been executed yet." }, "failedTargetsCount": { "type": "integer", "description": "Count of the failed targets.", "format": "int32" }, "createdOn": { "type": "string", "description": "Creation datetime in UTC time.", "format": "date-time" }, "_links": { "type": "object", "properties": { "targets": { "description": "Relation to a collection of order targets.", "$ref": "#/components/schemas/Link" }, "createdBy": { "description": "Relation to the user who created this maintenance job.", "$ref": "#/components/schemas/Link" }, "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "targets": { "description": "Relation to a collection of order targets. Embed via a \"select-order: targets\" header.", "$ref": "#/components/schemas/OrderTargetCollectionResource" }, "createdBy": { "description": "Relation to the user who created this maintenance job. Embed via a \"select-emailorder: createdBy\" header.", "$ref": "#/components/schemas/UserResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "Representation of an email order." }, "EncryptedTextSettingDefinitionCreateCommand": { "title": "Encrypted text setting definition create command", "type": "object", "properties": { "defaultValue": { "type": "string", "description": "Default value for this encrypted text setting definition." }, "regularExpression": { "type": "string", "description": "Regular expression used to validate the value of this setting definition." }, "dataType": { "description": "Data type of the setting definition to create. Determines which additional properties apply.", "$ref": "#/components/schemas/SettingDefinitionType" }, "name": { "type": "string", "description": "Name of this setting definition." }, "categoryId": { "type": "string", "description": "Id of the setting category this setting definition belongs to.", "format": "uuid" }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelModel" }, "description": "Multi-language labels for the name of this setting definition." }, "allowSystemSetting": { "type": "boolean", "description": "When set, allows this setting to be configured at the system level." }, "allowUserSetting": { "type": "boolean", "description": "When set, allows this setting to be configured at the user level." }, "roleRequiredForChange": { "type": "string", "description": "Name of the role required to change settings of this definition." }, "userGroupSettingMode": { "enum": [ "None", "MaximumValue", "MinimumValue", "Manual", "FirstValue" ], "type": "string", "description": "Algorithm used to calculate the effective value for user group settings of this definition." }, "helpUrl": { "type": "string", "description": "URL to help documentation for this setting definition." }, "tag": { "type": "string", "description": "Free-form tag for this setting definition." } }, "description": "Creates a new encrypted text setting definition." }, "EncryptedTextSettingDefinitionResource": { "title": "Encrypted text setting definition resource", "type": "object", "properties": { "defaultValue": { "type": "string", "description": "Default value of the setting" }, "regularExpression": { "type": "string", "description": "Regular expression that the setting value should match" }, "id": { "type": "string", "description": "Id of the setting definition", "format": "uuid" }, "helpUrl": { "type": "string", "description": "Help url for the setting definition" }, "userGroupSettingMode": { "enum": [ "None", "MaximumValue", "MinimumValue", "Manual", "FirstValue" ], "type": "string", "description": "UserGroupSettingMode for the setting definition" }, "categoryId": { "type": "string", "description": "Category Id for the setting definition", "format": "uuid" }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelNonResource" }, "description": "Collection of labels for the setting definition" }, "allowSystemSetting": { "type": "boolean", "description": "Indicates whether this setting can be configured at the system level." }, "allowUserSetting": { "type": "boolean", "description": "Indicates whether this setting can be configured per user." }, "roleRequiredForChange": { "type": "string", "description": "Role that needs to be changed" }, "name": { "type": "string", "description": "Name of the setting definition" }, "dataType": { "enum": [ "None", "Boolean", "Text", "Numeric", "DateTime", "Xml", "Role", "Reference", "EncryptedText", "DefSchema" ], "type": "string", "description": "Data type of this setting" }, "tag": { "type": "string", "description": "Tag for this setting containing extra information. Opt-in: returned only when requested. Include via a \"select-settingdefinition: Tag\" header." }, "modifiedOn": { "type": "string", "description": "Last modification datetime in UTC time.", "format": "date-time" }, "createdOn": { "type": "string", "description": "Creation datetime in UTC time.", "format": "date-time" }, "_links": { "type": "object", "properties": { "modifiedBy": { "description": "Relation to the user who last modified this settingdefinition.", "$ref": "#/components/schemas/Link" }, "createdBy": { "description": "Relation to the user who created this settingdefinition.", "$ref": "#/components/schemas/Link" }, "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "modifiedBy": { "description": "Relation to the user who last modified this settingdefinition. Embed via a \"select-encryptedtextsettingdefinition: modifiedBy\" header.", "$ref": "#/components/schemas/UserResource" }, "createdBy": { "description": "Relation to the user who created this settingdefinition. Embed via a \"select-encryptedtextsettingdefinition: createdBy\" header.", "$ref": "#/components/schemas/UserResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "Representation of an encrypted text-based system setting definition." }, "EnhancedCaptioningActionParametersModel": { "title": "Enhanced captioning action parameters model", "type": "object", "description": "Parameters for the \"EnhancedCaptioning\" maintenance job action. This action takes no parameters." }, "EnhancedCaptioningRuleActionModel": { "title": "Enhanced captioning rule action model", "type": "object", "properties": { "index": { "type": "integer", "description": "Index of the action within the rule's action collection", "format": "int32" }, "actionType": { "description": "Type of action to be executed.", "$ref": "#/components/schemas/RuleActionDataType" }, "executionTime": { "description": "When the action should be executed.", "$ref": "#/components/schemas/RuleExecutionTime" } }, "description": "Model for EnhancedCaptioning rule action" }, "EnhancedCaptioningRuleActionNonResource": { "title": "Enhanced captioning rule action non resource", "type": "object", "properties": { "index": { "type": "integer", "description": "Index of a rule action in collection", "format": "int32" }, "actionType": { "description": "Data type of this rule action", "$ref": "#/components/schemas/RuleActionDataType" }, "executionTime": { "description": "Execution time of the rule action", "$ref": "#/components/schemas/RuleExecutionTime" } }, "description": "Representation of enhanced captioning rule action" }, "ErrorMessageNonResource": { "title": "Error message non resource", "type": "object", "properties": { "errorMessages": { "type": "array", "items": { "type": "string" }, "description": "Array of error messages associated with the record." }, "recordIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "List of unique identifiers for the records associated with the error messages. This list can contain multiple record identifiers if the same set of error messages apply to multiple records." } }, "description": "Represents a non-resource error message, which includes a collection of error messages and associated record identifiers." }, "ExportAuditDownloadLinkTargetCollectionResource": { "title": "Export audit download link target collection resource", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ExportAuditDownloadLinkTargetResource" }, "description": "A collection of resource items." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "A collection of export audit download link targets" }, "ExportAuditDownloadLinkTargetResource": { "title": "Export audit download link target resource", "type": "object", "properties": { "recordId": { "type": "string", "description": "The identifier of the record this target represents.", "format": "uuid" }, "id": { "type": "string", "description": "The Id of this target.", "format": "uuid" }, "status": { "description": "The status of this target.", "$ref": "#/components/schemas/MaintenanceTargetResourceStatus" }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of an export audit download link target" }, "ExportAuditMaintenanceJobCommand": { "title": "Export audit maintenance job command", "type": "object", "properties": { "dateFrom": { "type": "string", "description": "Start date of the audit trail export range.", "format": "date-time" }, "dateTo": { "type": "string", "description": "End date of the audit trail export range.", "format": "date-time" }, "creatorEmail": { "type": "string", "description": "Email address of the user the job is created on behalf of." }, "disableNotification": { "type": "boolean", "description": "When set to true, suppresses notifications for this job." }, "earliestStartDate": { "type": [ "null", "string" ], "description": "Earliest date and time at which the job is allowed to start executing.", "format": "date-time" }, "priority": { "enum": [ "High", "Medium" ], "type": "string", "description": "Priority used to schedule this job relative to other maintenance jobs." }, "type": { "enum": [ "Classification", "Record", "ExportAuditTrail", "BulkRecord", "AcceptDownloadOrderAgreement", "BulkCollection", "ExportContentItemsList" ], "type": "string", "description": "Type of maintenance job to create." }, "targets": { "type": "array", "items": { "$ref": "#/components/schemas/ExportAuditMaintenanceJobTargetModel" }, "description": "Targets the job's actions are applied to." }, "actions": { "type": "array", "items": { "$ref": "#/components/schemas/ActionModel" }, "description": "Actions to execute for each target of this job." }, "title": { "type": "string", "description": "Title of the job. For a download or contact-sheet order this is shown on the Downloads page in Content Workspace; if omitted, it defaults to the file name, or \"X items\" when multiple files were ordered. Either plain text, or a JSON string of the form {\"studioName\":\"...\",\"moduleName\":\"...\",\"translationKey\":\"...\"} to look up a translated value for non-English users (see the Localization > Translations section of the DAM Administrator Guide for how translations are registered)." }, "description": { "type": "string", "description": "Description of the job. For a download or contact-sheet order this is shown on the Downloads page in Content Workspace; if omitted, it defaults to \"Download\". Accepts the same plain-text-or-translation-key JSON format as Title." }, "errorMode": { "type": "string", "description": "Determines how the job behaves when one of its targets fails to execute." } }, "description": "Creates a maintenance job that exports the audit trail for a record within a date range." }, "ExportAuditMaintenanceJobResource": { "title": "Export audit maintenance job resource", "type": "object", "properties": { "deliveredFile": { "type": "string", "description": "Holds the value of the DeliveredFile Path." }, "exportFileName": { "type": "string", "description": "Holds the value of the Exported Filename." }, "creatorEmail": { "type": "string", "description": "E-mail address for this job" }, "disableNotification": { "type": "boolean", "description": "Value indicating whether or not notification is enabled on this job" }, "earliestStartDate": { "type": [ "null", "string" ], "description": "The earliest date in utc time on which this job can be executed.", "format": "date-time" }, "executionTime": { "type": "string", "description": "Time it took for this maintenance job to execute." }, "id": { "type": "string", "description": "Id of this maintenance job.", "format": "uuid" }, "type": { "type": "string", "description": "Name of this maintenance job." }, "priority": { "enum": [ "High", "Medium", "AuditArchiving", "BuildSearchIndex" ], "type": "string", "description": "Priority of this maintenance job." }, "startedOn": { "type": [ "null", "string" ], "description": "Time on which the execution of this maintenance job started in utc time.", "format": "date-time" }, "status": { "enum": [ "Pending", "Success", "Failed", "PartiallyFailed", "Executing", "Cancelled", "Scheduled", "Queued", "AsyncPending", "AsyncExecuting" ], "type": "string", "description": "Status of this maintenance job." }, "message": { "type": [ "null", "string" ], "description": "Error message that describes why this maintenance job failed. Returns null if this maintenance job hasn't been executed yet." }, "failedTargetsCount": { "type": "integer", "description": "Count of the failed targets.", "format": "int32" }, "createdOn": { "type": "string", "description": "Creation datetime in UTC time.", "format": "date-time" }, "_links": { "type": "object", "properties": { "createdBy": { "description": "Relation to the user who created this maintenance job.", "$ref": "#/components/schemas/Link" }, "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "createdBy": { "description": "Relation to the user who created this maintenance job. Embed via a \"select-exportauditmaintenancejob: createdBy\" header.", "$ref": "#/components/schemas/UserResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "A background job that exports the audit trail for a set of records to a downloadable file." }, "ExportAuditMaintenanceJobTargetModel": { "title": "Export audit maintenance job target model", "type": "object", "properties": { "recordId": { "type": "string", "description": "Id of the record whose audit trail is exported.", "format": "uuid" }, "forceRetry": { "type": "boolean", "description": "When set to true, forces this target to be retried even if it previously failed." }, "tag": { "type": "string", "description": "Free-form tag that can be used to identify or group this target." } }, "description": "Target for an export audit trail maintenance job." }, "ExportContentItemsListColumnModel": { "title": "Export content items list column model", "type": "object", "properties": { "fieldName": { "type": "string" }, "localizedHeader": { "type": "string" }, "kind": { "type": "integer", "description": "Maps to ListExportColumnKind: Text=0, MultiValue=1, Hyperlink=2, Thumbnail=3, TitleLink=4.", "format": "int32" } } }, "ExportContentItemsListMaintenanceJobCommand": { "title": "Export content items list maintenance job command", "type": "object", "properties": { "columns": { "type": "array", "items": { "$ref": "#/components/schemas/ExportContentItemsListColumnModel" } }, "uiLanguage": { "type": "string" }, "uiCulture": { "type": "string" }, "contentLanguage": { "type": "string" }, "contentLanguageId": { "type": "string", "format": "uuid" }, "sourceView": { "type": "string" }, "filters": { "type": "string" }, "assetDetailUrlTemplate": { "type": "string" }, "deliveryLocation": { "type": "string" }, "orderedRecordIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Explicit Excel row order. When set, preferred over Targets enumeration order." }, "creatorEmail": { "type": "string", "description": "Email address of the user the job is created on behalf of." }, "disableNotification": { "type": "boolean", "description": "When set to true, suppresses notifications for this job." }, "earliestStartDate": { "type": [ "null", "string" ], "description": "Earliest date and time at which the job is allowed to start executing.", "format": "date-time" }, "priority": { "enum": [ "High", "Medium" ], "type": "string", "description": "Priority used to schedule this job relative to other maintenance jobs." }, "type": { "enum": [ "Classification", "Record", "ExportAuditTrail", "BulkRecord", "AcceptDownloadOrderAgreement", "BulkCollection", "ExportContentItemsList" ], "type": "string", "description": "Type of maintenance job to create." }, "targets": { "type": "array", "items": { "$ref": "#/components/schemas/ExportContentItemsListMaintenanceJobTargetModel" }, "description": "Targets the job's actions are applied to." }, "actions": { "type": "array", "items": { "$ref": "#/components/schemas/ActionModel" }, "description": "Actions to execute for each target of this job." }, "title": { "type": "string", "description": "Title of the job. For a download or contact-sheet order this is shown on the Downloads page in Content Workspace; if omitted, it defaults to the file name, or \"X items\" when multiple files were ordered. Either plain text, or a JSON string of the form {\"studioName\":\"...\",\"moduleName\":\"...\",\"translationKey\":\"...\"} to look up a translated value for non-English users (see the Localization > Translations section of the DAM Administrator Guide for how translations are registered)." }, "description": { "type": "string", "description": "Description of the job. For a download or contact-sheet order this is shown on the Downloads page in Content Workspace; if omitted, it defaults to \"Download\". Accepts the same plain-text-or-translation-key JSON format as Title." }, "errorMode": { "type": "string", "description": "Determines how the job behaves when one of its targets fails to execute." } } }, "ExportContentItemsListMaintenanceJobTargetModel": { "title": "Export content items list maintenance job target model", "type": "object", "properties": { "recordId": { "type": "string", "format": "uuid" }, "forceRetry": { "type": "boolean", "description": "When set to true, forces this target to be retried even if it previously failed." }, "tag": { "type": "string", "description": "Free-form tag that can be used to identify or group this target." } } }, "ExportMetadataDownloadLinkTargetCollectionResource": { "title": "Export metadata download link target collection resource", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ExportMetadataDownloadLinkTargetResource" }, "description": "A collection of resource items." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "A collection of export metadata download link targets" }, "ExportMetadataDownloadLinkTargetResource": { "title": "Export metadata download link target resource", "type": "object", "properties": { "objectId": { "type": "string", "description": "Record Id that represents this maintenance target", "format": "uuid" }, "id": { "type": "string", "description": "The Id of this target.", "format": "uuid" }, "status": { "description": "The status of this target.", "$ref": "#/components/schemas/MaintenanceTargetResourceStatus" }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of a export metadata download link target" }, "ExternalFileResource": { "title": "External file resource", "type": "object", "properties": { "id": { "type": "string", "description": "Identifier for this additional file.", "format": "uuid" }, "type": { "description": "Type of this additional file. On the additional files collection endpoint, the results can be restricted to specific types with a \"select-additionalfile-type\" request header (comma-separated AdditionalFileType names).", "$ref": "#/components/schemas/AdditionalFileType" }, "isManual": { "type": "boolean", "description": "Returns true if this additional has been added manually. false is returned if the additional file was created automatically." }, "label": { "type": "string", "description": "Label of the additional file" }, "fileSize": { "type": "integer", "description": "File size of the additional file", "format": "int64" }, "fileName": { "type": "string", "description": "File name of the additional file" }, "extension": { "type": "string", "description": "File extension of the additional file" }, "tag": { "type": "string", "description": "Tag of the additional file Opt-in: returned only when requested. Include via a \"select-additionalfile: Tag\" header." }, "usages": { "type": "array", "items": { "type": "string" }, "description": "Usages of the additional file. On the additional files collection endpoint, the results can be restricted to specific usages with a \"select-additionalfile-usage\" request header (comma-separated values)." }, "uri": { "type": "string", "description": "Returns a path to image or if no image is assigned. This URL remains valid for four hours. Opt-in: returned only when requested. Include via a \"select-additionalfile: Uri\" header." }, "metadata": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Technical metadata specific to this additional file's type (e.g. video duration, image resolution). The available keys vary by file type and aren't individually documented. Opt-in: returned only when requested. Include via a \"select-additionalfile: Metadata\" header." }, "purposes": { "type": "array", "items": { "type": "string" }, "description": "Purposes of the additional file. On the additional files collection endpoint, the results can be restricted to specific purposes with a \"select-filter-purposes\" request header (comma-separated values)." }, "crc32": { "type": "integer", "description": "CRC32 checksum of this additional file.", "format": "int32" }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" }, "publicLink": { "description": "Relation to the addition file public link.", "$ref": "#/components/schemas/Link" }, "mainPreview": { "description": "Relation to an image of main preview with the size of a preview.", "$ref": "#/components/schemas/Link" }, "filePreviews": { "description": "Relation to a collection of file previews.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "publicLink": { "description": "Relation to the addition file public link. Embed via a \"select-additionalfile: publicLink\" header.", "$ref": "#/components/schemas/PublicLinkResource" }, "mainPreview": { "description": "Relation to an image of main preview with the size of a preview. Embed via a \"select-additionalfile: mainPreview\" header.", "$ref": "#/components/schemas/ImageResource" }, "filePreviews": { "description": "Relation to a collection of file previews. Embed via a \"select-additionalfile: filePreviews\" header.", "$ref": "#/components/schemas/AdditionalFilePreviewCollectionResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "Representation of an external file" }, "FacetNonResource": { "title": "Facet non resource", "type": "object", "properties": { "name": { "type": "string", "description": "The name the client gave this facet" }, "values": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/FacetValueNonResourceOfDecimal" }, { "$ref": "#/components/schemas/FacetValueNonResourceOfRangeKeyOfDecimal" }, { "$ref": "#/components/schemas/FacetValueNonResourceOfGuid" }, { "$ref": "#/components/schemas/FacetValueNonResourceOfDateTime" }, { "$ref": "#/components/schemas/FacetValueNonResourceOfString" }, { "$ref": "#/components/schemas/FacetValueNonResourceOfRangeKeyOfDateTime" }, { "$ref": "#/components/schemas/FacetValueNonResourceOfRangeKeyOfSpecialDate" }, { "$ref": "#/components/schemas/FacetValueNonResourceOfRangeKeyOfTime" } ] }, "description": "The values for this facet" } }, "description": "Facet information" }, "FacetValueNonResourceOfDateTime": { "title": "Facet value non resource of date time", "type": "object", "properties": { "key": { "type": "string", "description": "The key of this facet value", "format": "date-time" }, "count": { "type": "integer", "description": "The number of hits that this facet applies to", "format": "int64" } }, "description": "Represents a facet value, containing a key for this facet and a count of matching hits" }, "FacetValueNonResourceOfDecimal": { "title": "Facet value non resource of decimal", "type": "object", "properties": { "key": { "type": "number", "description": "The key of this facet value", "format": "double" }, "count": { "type": "integer", "description": "The number of hits that this facet applies to", "format": "int64" } }, "description": "Represents a facet value, containing a key for this facet and a count of matching hits" }, "FacetValueNonResourceOfGuid": { "title": "Facet value non resource of guid", "type": "object", "properties": { "key": { "type": "string", "description": "The key of this facet value", "format": "uuid" }, "count": { "type": "integer", "description": "The number of hits that this facet applies to", "format": "int64" } }, "description": "Represents a facet value, containing a key for this facet and a count of matching hits" }, "FacetValueNonResourceOfRangeKeyOfDateTime": { "title": "Facet value non resource of range key of date time", "type": "object", "properties": { "key": { "description": "The key of this facet value", "$ref": "#/components/schemas/RangeKeyOfDateTime" }, "count": { "type": "integer", "description": "The number of hits that this facet applies to", "format": "int64" } }, "description": "Represents a facet value, containing a key for this facet and a count of matching hits" }, "FacetValueNonResourceOfRangeKeyOfDecimal": { "title": "Facet value non resource of range key of decimal", "type": "object", "properties": { "key": { "description": "The key of this facet value", "$ref": "#/components/schemas/RangeKeyOfDecimal" }, "count": { "type": "integer", "description": "The number of hits that this facet applies to", "format": "int64" } }, "description": "Represents a facet value, containing a key for this facet and a count of matching hits" }, "FacetValueNonResourceOfRangeKeyOfSpecialDate": { "title": "Facet value non resource of range key of special date", "type": "object", "properties": { "key": { "description": "The key of this facet value", "$ref": "#/components/schemas/RangeKeyOfSpecialDate" }, "count": { "type": "integer", "description": "The number of hits that this facet applies to", "format": "int64" } }, "description": "Represents a facet value, containing a key for this facet and a count of matching hits" }, "FacetValueNonResourceOfRangeKeyOfTime": { "title": "Facet value non resource of range key of time", "type": "object", "properties": { "key": { "description": "The key of this facet value", "$ref": "#/components/schemas/RangeKeyOfTime" }, "count": { "type": "integer", "description": "The number of hits that this facet applies to", "format": "int64" } }, "description": "Represents a facet value, containing a key for this facet and a count of matching hits" }, "FacetValueNonResourceOfString": { "title": "Facet value non resource of string", "type": "object", "properties": { "key": { "type": "string", "description": "The key of this facet value" }, "count": { "type": "integer", "description": "The number of hits that this facet applies to", "format": "int64" } }, "description": "Represents a facet value, containing a key for this facet and a count of matching hits" }, "FieldCollectionModel": { "title": "Field collection model", "type": "object", "properties": { "addOrUpdate": { "type": "array", "items": { "$ref": "#/components/schemas/FieldModel" }, "description": "The field values to add or update." }, "remove": { "type": "array", "items": { "$ref": "#/components/schemas/FieldModel" }, "description": "The field values to remove." } }, "description": "Collection of field values to add, update, or remove on a record." }, "FieldCollectionResource": { "title": "Field collection resource", "type": "object", "properties": { "items": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/SingleLineTextFieldResource" }, { "$ref": "#/components/schemas/MultiLineTextFieldResource" }, { "$ref": "#/components/schemas/NumericFieldResource" }, { "$ref": "#/components/schemas/DateTimeFieldResource" }, { "$ref": "#/components/schemas/DateFieldResource" }, { "$ref": "#/components/schemas/TimeFieldResource" }, { "$ref": "#/components/schemas/OptionListFieldResource" }, { "$ref": "#/components/schemas/DurationFieldResource" }, { "$ref": "#/components/schemas/UserListFieldResource" }, { "$ref": "#/components/schemas/UserGroupListFieldResource" }, { "$ref": "#/components/schemas/HtmlFieldResource" }, { "$ref": "#/components/schemas/JsonFieldResource" }, { "$ref": "#/components/schemas/ClassificationListFieldResource" }, { "$ref": "#/components/schemas/RecordListFieldResource" }, { "$ref": "#/components/schemas/RecordLinkFieldResource" }, { "$ref": "#/components/schemas/LanguageListFieldResource" }, { "$ref": "#/components/schemas/TextListFieldResource" }, { "$ref": "#/components/schemas/HyperlinkListFieldResource" } ], "discriminator": { "propertyName": "dataType", "mapping": { "SingleLineText": "#/components/schemas/SingleLineTextFieldResource", "MultiLineText": "#/components/schemas/MultiLineTextFieldResource", "Numeric": "#/components/schemas/NumericFieldResource", "DateTime": "#/components/schemas/DateTimeFieldResource", "Date": "#/components/schemas/DateFieldResource", "Time": "#/components/schemas/TimeFieldResource", "OptionList": "#/components/schemas/OptionListFieldResource", "Duration": "#/components/schemas/DurationFieldResource", "UserList": "#/components/schemas/UserListFieldResource", "UserGroupList": "#/components/schemas/UserGroupListFieldResource", "Html": "#/components/schemas/HtmlFieldResource", "Json": "#/components/schemas/JsonFieldResource", "ClassificationList": "#/components/schemas/ClassificationListFieldResource", "RecordList": "#/components/schemas/RecordListFieldResource", "RecordLink": "#/components/schemas/RecordLinkFieldResource", "LanguageList": "#/components/schemas/LanguageListFieldResource", "TextList": "#/components/schemas/TextListFieldResource", "HyperlinkList": "#/components/schemas/HyperlinkListFieldResource" } } }, "description": "A collection of resource items." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of a non-paged collection of fields" }, "FieldDataType": { "title": "Field data type", "enum": [ "None", "SingleLineText", "MultiLineText", "Numeric", "DateTime", "Date", "Time", "OptionList", "Duration", "UserList", "UserGroupList", "Html", "Json", "ClassificationList", "RecordList", "RecordLink", "LanguageList", "TextList", "HyperlinkList" ], "type": "string", "x-enum-descriptions": [ "No data type is set.", "Represents a field with a single line string value.", "Represents a field with a multi line string value.", "Represents a field with a numeric value.", "Represents a field with a datetime value", "Represents a field with a date value", "Represents a field with a time value", "An option list field contains 0, 1 or more values from a predefined list of options.", "Represents a duration field.", "Represents a user list field.", "Represents a user group list field.", "Represents a field with a string value containing HTML code.", "Represents a field with a string value containing JSON code.", "Represents a classification list field", "Represents a record list field.", "Represents a record link field.", "Represents a language list field", "Represents a text list field.", "Represents a hyperlink list field" ] }, "FieldDefinitionCollectionResource": { "title": "Field definition collection resource", "type": "object", "properties": { "items": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/HtmlFieldDefinitionResource" }, { "$ref": "#/components/schemas/MultiLineTextFieldDefinitionResource" }, { "$ref": "#/components/schemas/SingleLineTextFieldDefinitionResource" }, { "$ref": "#/components/schemas/JsonFieldDefinitionResource" }, { "$ref": "#/components/schemas/NumericFieldDefinitionResource" }, { "$ref": "#/components/schemas/ClassificationListFieldDefinitionResource" }, { "$ref": "#/components/schemas/DateFieldDefinitionResource" }, { "$ref": "#/components/schemas/DateTimeFieldDefinitionResource" }, { "$ref": "#/components/schemas/DurationFieldDefinitionResource" }, { "$ref": "#/components/schemas/OptionListFieldDefinitionResource" }, { "$ref": "#/components/schemas/RecordLinkFieldDefinitionResource" }, { "$ref": "#/components/schemas/RecordListFieldDefinitionResource" }, { "$ref": "#/components/schemas/TimeFieldDefinitionResource" }, { "$ref": "#/components/schemas/UserListFieldDefinitionResource" }, { "$ref": "#/components/schemas/UserGroupListFieldDefinitionResource" }, { "$ref": "#/components/schemas/LanguageListFieldDefinitionResource" }, { "$ref": "#/components/schemas/TextListFieldDefinitionResource" }, { "$ref": "#/components/schemas/HyperlinkListFieldDefinitionResource" } ] }, "description": "A collection of resource items." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of a collection of field definitions" }, "FieldDefinitionEditCommand": { "title": "Field definition edit command", "type": "object", "properties": { "datePattern": { "type": "string", "description": "Pattern used to format and parse the date value." }, "yearMonthPattern": { "type": "string", "description": "Pattern used to format and parse the date value when only year and month are captured." }, "dateTimePattern": { "type": "string", "description": "Pattern used to format and parse the date and time value." }, "useUtc": { "type": "boolean", "description": "When set to true, the value is stored and interpreted as UTC." }, "maximumLength": { "type": "integer", "description": "Maximum number of characters allowed for the field value.", "format": "int32" }, "minimumLength": { "type": "integer", "description": "Minimum number of characters required for the field value.", "format": "int32" }, "regularExpression": { "type": "string", "description": "Regular expression the field value must match." }, "accuracy": { "type": "number", "description": "Number of decimal places the field value is rounded to.", "format": "double" }, "range": { "type": "string", "description": "Range of allowed values for the field." }, "acceptMultipleOptions": { "type": "boolean", "description": "When set to true, multiple options can be selected for this field." }, "restrictValuesToLeafNodes": { "type": "boolean", "description": "When set to true, only leaf-node classifications can be selected." }, "items": { "description": "Options available for this field. Use Items.AddOrUpdate to add or update options, or Items.Remove to remove them.", "$ref": "#/components/schemas/OptionListItemCollectionModel" }, "sortOrder": { "type": "string", "description": "Sort order applied to the options of this field." }, "parentClassifications": { "description": "Classifications the record containing this field must belong to. Use AddOrUpdate to add or update members, or Remove to remove them.", "$ref": "#/components/schemas/EditableIdCollectionModel" }, "parentContentTypes": { "description": "Content types the record containing this field must have. Use AddOrUpdate to add or update members, or Remove to remove them.", "$ref": "#/components/schemas/EditableStringIdCollectionModel" }, "parentLabels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelModel" }, "description": "Multi-language labels shown for this field on the record containing it." }, "childClassifications": { "description": "Classifications the linked (child) records must belong to. Use AddOrUpdate to add or update members, or Remove to remove them.", "$ref": "#/components/schemas/EditableIdCollectionModel" }, "childContentTypes": { "description": "Content types the linked (child) records must have. Use AddOrUpdate to add or update members, or Remove to remove them.", "$ref": "#/components/schemas/EditableStringIdCollectionModel" }, "childLabels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelModel" }, "description": "Multi-language labels shown for this field on the linked (child) record." }, "linkClassifications": { "description": "Classifications assigned to the record when it is linked. Use AddOrUpdate to add or update members, or Remove to remove them.", "$ref": "#/components/schemas/EditableIdCollectionModel" }, "linkContentTypes": { "description": "Content types assigned to the record when it is linked. Use AddOrUpdate to add or update members, or Remove to remove them.", "$ref": "#/components/schemas/EditableStringIdCollectionModel" }, "linkType": { "type": "string", "description": "Type of link created between the records." }, "showSummaryImage": { "type": "boolean", "description": "When set to true, the summary image of the linked record is shown." }, "summaryFieldId": { "type": [ "null", "string" ], "description": "Id of the field used as the summary field for the linked record(s).", "format": "uuid" }, "isUniqueIdentifier": { "type": "boolean", "description": "When set to true, the field value must be unique across records." }, "timePattern": { "type": "string", "description": "Pattern used to format and parse the time value." }, "rootId": { "type": "string", "description": "Id of the root classification from which selectable values are taken.", "format": "uuid" }, "linkRecordToSelectedClassifications": { "type": "boolean", "description": "When set to true, the record is linked to the classifications selected in this field." }, "filter": { "type": "string", "description": "Filter expression applied to restrict the available options, classifications, users, or user groups, depending on the field definition's type." }, "defaultSelectionDisplayMode": { "enum": [ "Search", "Browse" ], "type": "string", "description": "Display mode used to select values, using the same values as ClassificationListFieldSelectionDisplayMode." }, "aIEnabled": { "type": "boolean", "description": "When set to true, AI-based content generation is enabled for this field." }, "parentHelpTexts": { "type": "array", "items": { "$ref": "#/components/schemas/LabelModel" }, "description": "Multi-language help texts shown for this field on the record containing it." }, "childHelpTexts": { "type": "array", "items": { "$ref": "#/components/schemas/LabelModel" }, "description": "Multi-language help texts shown for this field on the linked (child) record." }, "metadataPredictionEnabled": { "type": "boolean", "description": "When set to true, this field's value can be predicted using AI-based metadata prediction." }, "hints": { "type": "string", "description": "Hints used to guide AI-based metadata prediction for this field." }, "enabledLanguages": { "description": "Languages in which this field is enabled. Use AddOrUpdate to add or update members, or Remove to remove them.", "$ref": "#/components/schemas/EditableIdCollectionModel" }, "indexed": { "type": "boolean", "description": "When set to true, the field is indexed for search." }, "inlineStyle": { "type": "string", "description": "Inline CSS style applied to the field in the DAM UI." }, "isReadOnly": { "type": "boolean", "description": "When set to true, the field cannot be edited." }, "isRequired": { "type": "boolean", "description": "When set to true, the field is required." }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelModel" }, "description": "Multi-language labels for the name of this field." }, "languageMode": { "type": "string", "description": "Language mode of the field." }, "memberships": { "description": "Field groups this field is a member of. Use AddOrUpdate to add or update members, or Remove to remove them.", "$ref": "#/components/schemas/EditableIdCollectionModel" }, "name": { "type": "string", "description": "Name of the field." }, "scope": { "type": "string", "description": "Scope of the field." }, "sortIndex": { "type": "integer", "description": "Sort index used to order the field relative to other fields.", "format": "int32" }, "tag": { "type": "string", "description": "Tag associated with the field." }, "defaultValue": { "type": "string", "description": "Default value assigned to the field." }, "resetToDefaultTriggers": { "type": "array", "items": { "type": "string" }, "description": "Names of the triggers that reset the field to its default value." }, "resetToDefaultFields": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Ids of the fields that reset this field to its default value when they change." }, "validation": { "type": "string", "description": "Validation expression applied to the field value." }, "validationErrorMessage": { "type": "string", "description": "Error message shown when validation fails." }, "validationTrigger": { "type": "string", "description": "Trigger that determines when validation is applied." }, "storageMode": { "type": "string", "description": "Storage mode of the field." }, "helpTexts": { "type": "array", "items": { "$ref": "#/components/schemas/HelpTextModel" }, "description": "Multi-language help texts for this field." } }, "description": "Command to edit a field definition. Combines the settings of every field definition type since the concrete type is not known up front; only the properties relevant to the field definition's actual type are applied." }, "FieldDefinitionPagedCollectionResource": { "title": "Field definition paged collection resource", "type": "object", "properties": { "pageNumber": { "type": [ "null", "integer" ], "description": "The current page of this paged collection.", "format": "int32" }, "pageSize": { "type": [ "null", "integer" ], "description": "The current page size of this paged collection.", "format": "int32" }, "skip": { "type": [ "null", "integer" ], "description": "The current skip size of this paged collection.", "format": "int32" }, "take": { "type": [ "null", "integer" ], "description": "The current take size of this paged collection.", "format": "int32" }, "totalCount": { "type": "integer", "description": "The total count of items in this paged collection, not just on the current page.", "format": "int64" }, "items": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/HtmlFieldDefinitionResource" }, { "$ref": "#/components/schemas/MultiLineTextFieldDefinitionResource" }, { "$ref": "#/components/schemas/SingleLineTextFieldDefinitionResource" }, { "$ref": "#/components/schemas/JsonFieldDefinitionResource" }, { "$ref": "#/components/schemas/NumericFieldDefinitionResource" }, { "$ref": "#/components/schemas/ClassificationListFieldDefinitionResource" }, { "$ref": "#/components/schemas/DateFieldDefinitionResource" }, { "$ref": "#/components/schemas/DateTimeFieldDefinitionResource" }, { "$ref": "#/components/schemas/DurationFieldDefinitionResource" }, { "$ref": "#/components/schemas/OptionListFieldDefinitionResource" }, { "$ref": "#/components/schemas/RecordLinkFieldDefinitionResource" }, { "$ref": "#/components/schemas/RecordListFieldDefinitionResource" }, { "$ref": "#/components/schemas/TimeFieldDefinitionResource" }, { "$ref": "#/components/schemas/UserListFieldDefinitionResource" }, { "$ref": "#/components/schemas/UserGroupListFieldDefinitionResource" }, { "$ref": "#/components/schemas/LanguageListFieldDefinitionResource" }, { "$ref": "#/components/schemas/TextListFieldDefinitionResource" }, { "$ref": "#/components/schemas/HyperlinkListFieldDefinitionResource" } ] }, "description": "One page of this paged collection, which is a subcollection of the complete collection." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" }, "first": { "description": "A link to the first page of this paged collection.", "$ref": "#/components/schemas/Link" }, "prev": { "description": "A link to the previous page of this paged collection.", "$ref": "#/components/schemas/Link" }, "next": { "description": "A link to the next page of this paged collection.", "$ref": "#/components/schemas/Link" }, "last": { "description": "A link to the last page of this paged collection.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of a paged collection of field definitions" }, "FieldDefinitionResource": { "title": "Field definition resource", "type": "object", "properties": { "label": { "type": "string", "description": "Label of this field." }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelNonResource" }, "description": "A collection of Label items." }, "dataType": { "$ref": "#/components/schemas/FieldDataType" }, "scope": { "enum": [ "RecordContentGlobal", "RecordContentClassDependent", "RecordContentFloating", "ClassificationProfileClassDependent", "UserGlobal", "FileFileTypeDependent", "FileFloating", "IndexerTaskGlobal", "FileGlobal", "ClassificationProfileFloating", "RecordContentContentTypeDependent" ], "type": "string", "description": "Scope." }, "scopeCategory": { "enum": [ "Record", "File", "Classification", "User", "IndexerTask", "MetadataTemplate" ], "type": "string", "description": "Scope category." }, "indexed": { "type": "boolean", "description": "Indicator if searching on this field is enabled." }, "languageMode": { "enum": [ "Single", "Multiple" ], "type": "string", "description": "Language mode of the field." }, "memberships": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Memberships of a field." }, "searchIndexRebuildRequired": { "type": "boolean", "description": "Indicator if a search index rebuild is required." }, "enabledLanguages": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Enabled languages." }, "id": { "type": "string", "description": "Identifier for this field.", "format": "uuid" }, "name": { "type": "string", "description": "Name for this field." }, "isRequired": { "type": "boolean", "description": "Indicates whether this field is required." }, "isReadOnly": { "type": "boolean", "description": "Indicates whether this field is read only." }, "isUniqueIdentifier": { "type": "boolean", "description": "Indicates whether this field is a unique identifier." }, "inlineStyle": { "type": "string", "description": "Inline CSS style applied to this field." }, "sortIndex": { "type": "integer", "description": "Sorting index of this field.", "format": "int32" }, "tag": { "type": "string", "description": "Tag for this field containing extra information. Opt-in: returned only when requested. Include via a \"select-fielddefinition: Tag\" header." }, "createdOn": { "type": "string", "description": "Created on the specified date in UTC time", "format": "date-time" }, "modifiedOn": { "type": "string", "description": "Modified on the specified date in UTC time", "format": "date-time" }, "defaultValue": { "type": "string", "description": "Default value of this field." }, "resetToDefaultTriggers": { "type": "array", "items": { "enum": [ "None", "OnNewField", "OnLoad", "OnSave", "OnAnyFileChange", "OnReclassifyRecord", "OnAnyChange", "OnFieldChange", "OnMasterFileChange", "OnCurrentFileChange", "OnFieldDefinitionChanged", "OnDuplicateRecord", "OnRecordStatusChange" ], "type": "string" }, "description": "'reset to default triggers' value of this field." }, "validation": { "type": "string", "description": "Validation of this field." }, "validationErrorMessage": { "type": "string", "description": "Error message of this field." }, "validationTrigger": { "enum": [ "None", "WhenNeeded", "Always" ], "type": "string", "description": "Trigger that determines when validation is evaluated for this field." }, "storageMode": { "enum": [ "None", "NonEmptyValues", "AllValues", "LogChanges" ], "type": "string", "description": "Storage mode of this field." }, "resetToDefaultFields": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Fields that trigger this field to be reset back to its default value. This is only used if \"ResetToDefaultTriggers\" is set to \"OnFieldChange\"." }, "helpText": { "type": "string", "description": "Help text of this field." }, "helpTexts": { "type": "array", "items": { "$ref": "#/components/schemas/HelpTextNonResource" }, "description": "A collection of HelpText items." }, "_links": { "type": "object", "properties": { "createdBy": { "description": "Relation to the user who created this field definition.", "$ref": "#/components/schemas/Link" }, "modifiedBy": { "description": "Relation to the user who last modified this field definition.", "$ref": "#/components/schemas/Link" }, "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "createdBy": { "description": "Relation to the user who created this field definition. Embed via a \"select-fielddefinition: createdBy\" header.", "$ref": "#/components/schemas/UserResource" }, "modifiedBy": { "description": "Relation to the user who last modified this field definition. Embed via a \"select-fielddefinition: modifiedBy\" header.", "$ref": "#/components/schemas/UserResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "Defines a custom metadata field (name, data type, validation rules) that can be attached to classifications or content types and then populated with a value on each record." }, "FieldDefinitionSearchBodyResource": { "title": "Field definition search body resource", "type": "object", "properties": { "checkEditPermission": { "type": "boolean", "description": "Value indicating whether to only return field definitions the current user is allowed to edit." }, "filter": { "type": "string" }, "sort": { "type": "string" }, "skip": { "type": "integer", "format": "int32" }, "take": { "type": "integer", "format": "int32" } }, "description": "Represents the request body used to search field definitions." }, "FieldDefinitionType": { "title": "Field definition type", "enum": [ "ClassificationList", "Date", "DateTime", "Duration", "Html", "Json", "LanguageList", "MultiLineText", "Numeric", "OptionList", "RecordLink", "RecordList", "SingleLineText", "TextList", "Time", "UserGroupList", "UserList", "HyperlinkList" ], "type": "string", "x-enum-descriptions": [ "A field that links to one or more classifications.", "A field that stores a date without a time component.", "A field that stores a date and time.", "A field that stores a duration.", "A field that stores HTML content.", "A field that stores JSON content.", "A field that links to one or more languages.", "A field that stores multi-line text.", "A field that stores a numeric value.", "A field that stores one or more values selected from a predefined list of options.", "A field that links to a single related record.", "A field that links to one or more related records.", "A field that stores single-line text.", "A field that stores a list of text values.", "A field that stores a time without a date component.", "A field that links to one or more user groups.", "A field that links to one or more users.", "A field that stores a list of hyperlinks." ] }, "FieldGroupCreateCommand": { "title": "Field group create command", "type": "object", "properties": { "name": { "type": "string", "description": "The name of the field group." }, "tag": { "type": "string", "description": "The tag of the field group." }, "members": { "description": "The fields that belong to this field group. Use AddOrUpdate to add or update members, or Remove to remove them.", "$ref": "#/components/schemas/EditableIdCollectionModel" } }, "description": "Command to create a new field group." }, "FieldGroupEditCommand": { "title": "Field group edit command", "type": "object", "properties": { "name": { "type": "string", "description": "The name of the field group." }, "tag": { "type": "string", "description": "The tag of the field group." }, "members": { "description": "The fields that belong to this field group. Use AddOrUpdate to add or update members, or Remove to remove them.", "$ref": "#/components/schemas/EditableIdCollectionModel" } }, "description": "Command to edit an existing field group." }, "FieldGroupPagedCollectionResource": { "title": "Field group paged collection resource", "type": "object", "properties": { "pageNumber": { "type": [ "null", "integer" ], "description": "The current page of this paged collection.", "format": "int32" }, "pageSize": { "type": [ "null", "integer" ], "description": "The current page size of this paged collection.", "format": "int32" }, "skip": { "type": [ "null", "integer" ], "description": "The current skip size of this paged collection.", "format": "int32" }, "take": { "type": [ "null", "integer" ], "description": "The current take size of this paged collection.", "format": "int32" }, "totalCount": { "type": "integer", "description": "The total count of items in this paged collection, not just on the current page.", "format": "int64" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/FieldGroupResource" }, "description": "One page of this paged collection, which is a subcollection of the complete collection." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" }, "first": { "description": "A link to the first page of this paged collection.", "$ref": "#/components/schemas/Link" }, "prev": { "description": "A link to the previous page of this paged collection.", "$ref": "#/components/schemas/Link" }, "next": { "description": "A link to the next page of this paged collection.", "$ref": "#/components/schemas/Link" }, "last": { "description": "A link to the last page of this paged collection.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of a paged collection of field groups" }, "FieldGroupResource": { "title": "Field group resource", "type": "object", "properties": { "id": { "type": "string", "description": "Id of this field group.", "format": "uuid" }, "name": { "type": "string", "description": "Name of this field group." }, "tag": { "type": "string", "description": "Value of the Tag for this object. The value of this property has to be valid XML code. Opt-in: returned only when requested. Include via a \"select-fieldgroup: Tag\" header." }, "modifiedOn": { "type": "string", "description": "Last modification datetime in UTC time.", "format": "date-time" }, "createdOn": { "type": "string", "description": "Creation datetime in UTC time.", "format": "date-time" }, "_links": { "type": "object", "properties": { "members": { "description": "Relation to the field group members.", "$ref": "#/components/schemas/Link" }, "modifiedBy": { "description": "Relation to the user who last modified this field group.", "$ref": "#/components/schemas/Link" }, "createdBy": { "description": "Relation to the user who created this field grop.", "$ref": "#/components/schemas/Link" }, "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "members": { "description": "Relation to the field group members. Embed via a \"select-fieldgroup: members\" header.", "$ref": "#/components/schemas/FieldDefinitionCollectionResource" }, "modifiedBy": { "description": "Relation to the user who last modified this field group. Embed via a \"select-fieldgroup: modifiedBy\" header.", "$ref": "#/components/schemas/UserResource" }, "createdBy": { "description": "Relation to the user who created this field grop. Embed via a \"select-fieldgroup: createdBy\" header.", "$ref": "#/components/schemas/UserResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "A named grouping of field definitions, used to organize related fields together for display in the DAM UI." }, "FieldModel": { "title": "Field model", "type": "object", "properties": { "id": { "type": "string", "description": "The id of the field definition this value belongs to.", "format": "uuid" }, "name": { "type": "string", "description": "The name of the field definition this value belongs to. Can be used instead of Id." }, "localizedValues": { "type": "array", "items": { "$ref": "#/components/schemas/LocalizedValueModel" }, "description": "Per-language values for this field. Use AddOrUpdate to add or update a language's value, or Remove to clear it." } }, "description": "A field value on a record, identified by its field definition id or name." }, "FieldPopulationLogPredictionContentItemNonResource": { "title": "Field population log prediction content item non resource", "type": "object", "properties": { "id": { "type": "string", "description": "Id of the content item.", "format": "uuid" }, "title": { "type": "string", "description": "Title of the content item." }, "previewImage": { "type": "string", "description": "Preview URL of the content item." } }, "description": "Represents a content item (asset) suggested as a source for AI-predicted field population, identified by its Id, title, and preview image." }, "FieldPopulationLogPredictionPagedCollectionResource": { "title": "Field population log prediction paged collection resource", "type": "object", "properties": { "pageNumber": { "type": [ "null", "integer" ], "description": "The current page of this paged collection.", "format": "int32" }, "pageSize": { "type": [ "null", "integer" ], "description": "The current page size of this paged collection.", "format": "int32" }, "skip": { "type": [ "null", "integer" ], "description": "The current skip size of this paged collection.", "format": "int32" }, "take": { "type": [ "null", "integer" ], "description": "The current take size of this paged collection.", "format": "int32" }, "totalCount": { "type": "integer", "description": "The total count of items in this paged collection, not just on the current page.", "format": "int64" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/FieldPopulationLogPredictionResource" }, "description": "One page of this paged collection, which is a subcollection of the complete collection." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" }, "first": { "description": "A link to the first page of this paged collection.", "$ref": "#/components/schemas/Link" }, "prev": { "description": "A link to the previous page of this paged collection.", "$ref": "#/components/schemas/Link" }, "next": { "description": "A link to the next page of this paged collection.", "$ref": "#/components/schemas/Link" }, "last": { "description": "A link to the last page of this paged collection.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of a paged collection of field population log predictions" }, "FieldPopulationLogPredictionResource": { "title": "Field population log prediction resource", "type": "object", "properties": { "contentItem": { "description": "Content Item of the prediction.", "$ref": "#/components/schemas/FieldPopulationLogPredictionContentItemNonResource" }, "logDate": { "type": "string", "description": "DateTime of the prediction.", "format": "date-time" }, "initialValue": { "type": "string", "description": "Initial Value of the prediction." }, "lastChangeDate": { "type": [ "null", "string" ], "description": "Last Change information for the field.", "format": "date-time" }, "status": { "type": "string", "description": "Prediction Status for the field." }, "updatedValue": { "type": "string", "description": "Update Value for the field." }, "_links": { "type": "object", "properties": { "self": { "description": "Self Relation.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "A single machine-learning-predicted value for a field on a record, and whether that prediction was accepted or overwritten." }, "FieldPopulationLogSummaryPagedCollectionResource": { "title": "Field population log summary paged collection resource", "type": "object", "properties": { "pageNumber": { "type": [ "null", "integer" ], "description": "The current page of this paged collection.", "format": "int32" }, "pageSize": { "type": [ "null", "integer" ], "description": "The current page size of this paged collection.", "format": "int32" }, "skip": { "type": [ "null", "integer" ], "description": "The current skip size of this paged collection.", "format": "int32" }, "take": { "type": [ "null", "integer" ], "description": "The current take size of this paged collection.", "format": "int32" }, "totalCount": { "type": "integer", "description": "The total count of items in this paged collection, not just on the current page.", "format": "int64" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/FieldPopulationLogSummaryResource" }, "description": "One page of this paged collection, which is a subcollection of the complete collection." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" }, "first": { "description": "A link to the first page of this paged collection.", "$ref": "#/components/schemas/Link" }, "prev": { "description": "A link to the previous page of this paged collection.", "$ref": "#/components/schemas/Link" }, "next": { "description": "A link to the next page of this paged collection.", "$ref": "#/components/schemas/Link" }, "last": { "description": "A link to the last page of this paged collection.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of a paged collection of FieldPopulationLogSummary entries" }, "FieldPopulationLogSummaryResource": { "title": "Field population log summary resource", "type": "object", "properties": { "fieldId": { "type": "string", "description": "FieldId of the Field.", "format": "uuid" }, "fieldName": { "type": "string", "description": "FieldName of the Field." }, "hints": { "type": "string", "description": "Hints associated with the Field." }, "predictedPercent": { "type": "number", "description": "PredictedPercent for the Field.", "format": "double" }, "predictedCount": { "type": "integer", "description": "PredictedCount for the Field.", "format": "int32" }, "attemptedCount": { "type": "integer", "description": "AttemptedCount for the Field.", "format": "int32" }, "retainedPercent": { "type": "number", "description": "RetainedPercent for the Field.", "format": "double" }, "retainedCount": { "type": "integer", "description": "RetainedCount for the Field.", "format": "int32" }, "_links": { "type": "object", "properties": { "self": { "description": "Self Relation.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Aggregate stats for one field's machine-learning predictions: how often a value was predicted versus attempted, and how often the predicted value was retained (accepted) rather than overwritten." }, "FieldTitleConfigurationNonResource": { "title": "Field title configuration non resource", "type": "object", "properties": { "fieldId": { "type": "string", "description": "The field id the title should be retrieved from.", "format": "uuid" }, "option": { "enum": [ "FileName", "Field" ], "type": "string", "description": "Type of title configuration" } }, "description": "Represents the tile configuration for a content type." }, "FieldValueConditionMapping": { "title": "Field value condition mapping", "type": "object", "properties": { "fieldId": { "type": "string", "description": "The id of the field definition to compare.", "format": "uuid" }, "value": { "type": "string", "description": "The value to compare the field against." }, "operator": { "enum": [ "Equals", "DoesNotEqual", "GreaterThan", "GreaterThanOrEqual", "SmallerThan", "SmallerThanOrEqual", "After", "Before", "ContainsAnyOf", "Contains", "DoesNotContain", "StartsWith", "EqualsOneOf", "ContainsText", "FreeText", "Matches", "Between", "BasedOn", "NotBasedOn" ], "type": "string", "description": "The comparison operator to apply." } }, "description": "Describes a comparison between a field's value and an expected value." }, "FileAddedRuleConditionModel": { "title": "File added rule condition model", "type": "object", "properties": { "index": { "type": "integer", "description": "Index of the condition within the rule's condition collection", "format": "int32" }, "conditionType": { "description": "Type of condition to be evaluated.", "$ref": "#/components/schemas/RuleConditionDataType" } }, "description": "Model for FileAdded rule condition" }, "FileAddedRuleConditionNonResource": { "title": "File added rule condition non resource", "type": "object", "properties": { "index": { "type": "integer", "description": "Index of a rule condition in collection", "format": "int32" }, "conditionType": { "description": "Data type of this rule condition", "$ref": "#/components/schemas/RuleConditionDataType" } }, "description": "Representation of File Added rule condition" }, "FileCollectionResource": { "title": "File collection resource", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/FileResource" }, "description": "A collection of resource items." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of a non-paged collection of files" }, "FileConfigurationModel": { "title": "File configuration model", "type": "object", "properties": { "urlFieldId": { "type": "string", "description": "Id of the field containing the URL to crawl.", "format": "uuid" }, "crawlLevelOption": { "enum": [ "Fixed", "Field" ], "type": "string", "description": "Determines how the crawl depth level is resolved." }, "maximumNumberOfPages": { "type": "integer", "description": "Maximum number of pages to crawl.", "format": "int32" }, "crawlLevelFieldId": { "type": [ "null", "string" ], "description": "Id of the field used to resolve the crawl depth level, when CrawlLevelOption is set to use a field.", "format": "uuid" }, "crawlLevelValue": { "type": [ "null", "integer" ], "description": "Fixed crawl depth level, when CrawlLevelOption is set to a fixed value.", "format": "int32" }, "smartAgentId": { "type": [ "null", "integer" ], "description": "Id of the smart agent used to crawl the URL.", "format": "int32" } }, "description": "File-related configuration for a URL-based content type." }, "FileConfigurationNonResource": { "title": "File configuration non resource", "type": "object", "properties": { "urlFieldId": { "type": "string", "description": "URL field id.", "format": "uuid" }, "crawlLevelOption": { "enum": [ "Fixed", "Field" ], "type": "string", "description": "Option for the crawl level." }, "maximumNumberOfPages": { "type": "integer", "description": "Maximum number of pages.", "format": "int32" }, "crawlLevelFieldId": { "type": [ "null", "string" ], "description": "Crawl level field id.", "format": "uuid" }, "crawlLevelValue": { "type": [ "null", "integer" ], "description": "Crawl level value.", "format": "int32" }, "smartAgentId": { "type": [ "null", "integer" ], "description": "Smart agent.", "format": "int32" } }, "description": "Content type file configuration resource" }, "FileModel": { "title": "File model", "type": "object", "properties": { "id": { "type": "string", "description": "Identifier of the file." }, "fileName": { "type": "string", "description": "File name." }, "tag": { "type": "string", "description": "Tag used to distinguish or categorize this file." }, "comment": { "type": "string", "description": "Comment associated with the file." }, "versionLabel": { "type": "string", "description": "Version label of the file." }, "versions": { "$ref": "#/components/schemas/FileVersionsModel" }, "fields": { "description": "Field values to add, update, or remove on this file.", "$ref": "#/components/schemas/FieldCollectionModel" }, "watermarkType": { "description": "Watermark type applied to this file.", "$ref": "#/components/schemas/FileWatermarkType" }, "watermarkId": { "type": "string", "description": "Identifier of the watermark to apply, when WatermarkType is UseSpecified." } }, "description": "A file attached to a record." }, "FileNameTitleConfigurationNonResource": { "title": "File name title configuration non resource", "type": "object", "properties": { "showExtension": { "type": "boolean", "description": "Get a value that indicates if the filename extension should be shown" }, "option": { "enum": [ "FileName", "Field" ], "type": "string", "description": "Type of title configuration" } }, "description": "Represents the tile configuration for a content type using the file name." }, "FilePreviewCollectionResource": { "title": "File preview collection resource", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/FilePreviewResource" }, "description": "A collection of resource items." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of a non-paged collection of file previews" }, "FilePreviewModel": { "title": "File preview model", "type": "object", "properties": { "id": { "type": "string", "description": "Identifier of the preview. When adding a new preview, pass the upload token returned after uploading the file; when editing an existing preview, pass its GUID." }, "name": { "type": "string", "description": "Name of the preview." }, "pageNumber": { "type": [ "null", "integer" ], "description": "Page number this preview represents, for multi-page files.", "format": "int32" }, "tag": { "type": "string", "description": "Tag used to distinguish or categorize this preview." } }, "description": "A preview generated for a file version." }, "FilePreviewPagedCollectionResource": { "title": "File preview paged collection resource", "type": "object", "properties": { "pageNumber": { "type": [ "null", "integer" ], "description": "The current page of this paged collection.", "format": "int32" }, "pageSize": { "type": [ "null", "integer" ], "description": "The current page size of this paged collection.", "format": "int32" }, "skip": { "type": [ "null", "integer" ], "description": "The current skip size of this paged collection.", "format": "int32" }, "take": { "type": [ "null", "integer" ], "description": "The current take size of this paged collection.", "format": "int32" }, "totalCount": { "type": "integer", "description": "The total count of items in this paged collection, not just on the current page.", "format": "int64" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/FilePreviewResource" }, "description": "One page of this paged collection, which is a subcollection of the complete collection." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" }, "first": { "description": "A link to the first page of this paged collection.", "$ref": "#/components/schemas/Link" }, "prev": { "description": "A link to the previous page of this paged collection.", "$ref": "#/components/schemas/Link" }, "next": { "description": "A link to the next page of this paged collection.", "$ref": "#/components/schemas/Link" }, "last": { "description": "A link to the last page of this paged collection.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of a paged collection of file previews" }, "FilePreviewResource": { "title": "File preview resource", "type": "object", "properties": { "id": { "type": "string", "description": "Id of this preview.", "format": "uuid" }, "pageNumber": { "type": "integer", "description": "Page number of this preview. This is used to indicate of which page of a multi-page document this preview was created.", "format": "int32" }, "name": { "type": "string", "description": "Name of this preview. This name does not have to be unique, is not required and can be maximum 50 characters long." }, "isMaster": { "type": "boolean", "description": "Returns true if this is the master preview" }, "isManual": { "type": "boolean", "description": "Returns true if this preview has been added manually. false is returned if the preview was created automatically by any of the media engines." }, "tag": { "type": "string", "description": "Value of the Tag of this object. Opt-in: returned only when requested. Include via a \"select-filepreview: Tag\" header." }, "createdOn": { "type": "string", "description": "Created on.", "format": "date-time" }, "metadata": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Get the metadata." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" }, "preview": { "description": "Relation to an image with the size of a preview.", "$ref": "#/components/schemas/Link" }, "thumbnail": { "description": "Relation to an image with the size of a thumbnail.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "preview": { "description": "Relation to an image with the size of a preview. Embed via a \"select-filepreview: preview\" header.", "$ref": "#/components/schemas/ImageResource" }, "thumbnail": { "description": "Relation to an image with the size of a thumbnail. Embed via a \"select-filepreview: thumbnail\" header.", "$ref": "#/components/schemas/ImageResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "A single rendered preview image and its thumbnail for a specific file version; multi-page documents have one per page." }, "FilePreviewRotationAngleCommand": { "title": "File preview rotation angle command", "type": "object", "properties": { "value": { "type": "integer", "description": "Rotation angle, in degrees, to apply to the preview.", "format": "int32" } }, "description": "Rotation angle of a file preview." }, "FilePreviewsModel": { "title": "File previews model", "type": "object", "properties": { "master": { "type": "string", "description": "Identifier of the preview to use as the master preview." }, "addOrUpdate": { "type": "array", "items": { "$ref": "#/components/schemas/FilePreviewModel" }, "description": "The previews to add or update." }, "remove": { "type": "array", "items": { "$ref": "#/components/schemas/FilePreviewModel" }, "description": "The previews to remove." } }, "description": "Collection of previews to add, update, or remove on a file version." }, "FileProcessActionCollectionResource": { "title": "File process action collection resource", "type": "object", "properties": { "pageNumber": { "type": [ "null", "integer" ], "description": "The current page of this paged collection.", "format": "int32" }, "pageSize": { "type": [ "null", "integer" ], "description": "The current page size of this paged collection.", "format": "int32" }, "skip": { "type": [ "null", "integer" ], "description": "The current skip size of this paged collection.", "format": "int32" }, "take": { "type": [ "null", "integer" ], "description": "The current take size of this paged collection.", "format": "int32" }, "totalCount": { "type": "integer", "description": "The total count of items in this paged collection, not just on the current page.", "format": "int64" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/FileProcessActionResource" }, "description": "One page of this paged collection, which is a subcollection of the complete collection." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" }, "first": { "description": "A link to the first page of this paged collection.", "$ref": "#/components/schemas/Link" }, "prev": { "description": "A link to the previous page of this paged collection.", "$ref": "#/components/schemas/Link" }, "next": { "description": "A link to the next page of this paged collection.", "$ref": "#/components/schemas/Link" }, "last": { "description": "A link to the last page of this paged collection.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of a paged collection of file process actions" }, "FileProcessActionEditCommand": { "title": "File process action edit command", "type": "object", "properties": { "name": { "type": "string" }, "sortIndex": { "type": "integer", "format": "int32" }, "enabled": { "type": "boolean" }, "conditions": { "description": "Collection of conditions for this file process action. Use Conditions.AddOrUpdate to add new conditions or replace the entire collection.", "$ref": "#/components/schemas/FileProcessConditionsUpdate" }, "label": { "type": "string", "description": "Name label for this file process action in the current user's language" }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelModel" }, "description": "Multi-language labels for the name of this file process action" }, "description": { "type": "string", "description": "Description label for this file process action in the current user's language" }, "descriptions": { "type": "array", "items": { "$ref": "#/components/schemas/LabelModel" }, "description": "Multi-language labels for the description of this file process action" } } }, "FileProcessActionLogCollectionResource": { "title": "File process action log collection resource", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/FileProcessActionLogResource" }, "description": "A collection of resource items." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of a non-paged collection of file process action log entries." }, "FileProcessActionLogResource": { "title": "File process action log resource", "type": "object", "properties": { "id": { "type": "string", "description": "ID of the log.", "format": "uuid" }, "fileVersionId": { "type": "string", "description": "ID of the file version.", "format": "uuid" }, "label": { "type": "string", "description": "Label of the file process action." }, "description": { "type": "string", "description": "Description of the file process action." }, "status": { "enum": [ "Executing", "Succeeded", "Failed", "Skipped" ], "type": "string", "description": "Status of the file process action." }, "details": { "type": "string", "description": "Details from the log (optional)." }, "createdOn": { "type": "string", "description": "Timestamp when the log was created.", "format": "date-time" }, "completedOn": { "type": [ "null", "string" ], "description": "Timestamp when the log was finalized.", "format": "date-time" }, "_links": { "type": "object", "properties": { "self": { "description": "Self Relation.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "A single logged execution of a file process action against a file version, including its outcome and timing." }, "FileProcessActionResource": { "title": "File process action resource", "type": "object", "properties": { "id": { "type": "string", "description": "Identifier for this file process action.", "format": "uuid" }, "name": { "type": "string", "description": "Name of this file process action." }, "fileProcessActionStageId": { "type": "string", "description": "File process action stage identifier.", "format": "uuid" }, "fileProcessActionType": { "type": "string", "description": "File process action type." }, "sortIndex": { "type": "integer", "description": "Sort index for this file process action.", "format": "int32" }, "isConfigurable": { "type": "boolean", "description": "Whether this file process action is configurable." }, "enabled": { "type": "boolean", "description": "Whether this file process action is enabled." }, "allowed": { "type": "boolean", "description": "Whether this file process action is allowed by Feature Flags." }, "createdOn": { "type": "string", "description": "Creation date for this file process action.", "format": "date-time" }, "modifiedOn": { "type": "string", "description": "Modification date for this file process action.", "format": "date-time" }, "label": { "type": "string", "description": "Name label in the language of the currently logged in user." }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelNonResource" }, "description": "Collection of name labels for this file process action." }, "description": { "type": "string", "description": "Description label in the language of the currently logged in user." }, "descriptions": { "type": "array", "items": { "$ref": "#/components/schemas/LabelNonResource" }, "description": "Collection of description labels for this file process action." }, "conditions": { "description": "Collection of conditions for this file process action.", "$ref": "#/components/schemas/FileProcessConditionCollectionNonResource" }, "_links": { "type": "object", "properties": { "self": { "description": "Self relation for this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "A configurable processing step that runs at a specific stage of a file's processing pipeline, in a fixed sort order, and can be individually enabled or disabled." }, "FileProcessConditionCollectionNonResource": { "title": "File process condition collection non resource", "type": "object", "properties": { "conditions": { "type": "array", "items": { "type": "string" }, "description": "Collection of file process conditions" } }, "description": "Non-resource representation of a FileProcessCondition collection" }, "FileProcessConditionDataType": { "title": "File process condition data type", "enum": [ "FileType", "ContentTypeIs", "ClassifiedIn", "OnlyOnFirstVersion", "CompareFieldValue" ], "type": "string", "x-enum-descriptions": [ "Checks if the file is of specific type(s).", "Checks if the record is of a specific content type.", "Checks if the record is classified in a specific classification.", "Checks if the file is on its first version.", "Evaluates a field comparison expression." ] }, "FileProcessConditionsUpdate": { "title": "File process conditions update", "type": "object", "properties": { "addOrUpdate": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/FileTypeConditionModel" }, { "$ref": "#/components/schemas/ContentTypeIsConditionModel" }, { "$ref": "#/components/schemas/ClassifiedInConditionModel" }, { "$ref": "#/components/schemas/OnlyOnFirstVersionConditionModel" }, { "$ref": "#/components/schemas/CompareFieldValueConditionModel" } ], "discriminator": { "propertyName": "conditionType", "mapping": { "FileType": "#/components/schemas/FileTypeConditionModel", "ContentTypeIs": "#/components/schemas/ContentTypeIsConditionModel", "ClassifiedIn": "#/components/schemas/ClassifiedInConditionModel", "OnlyOnFirstVersion": "#/components/schemas/OnlyOnFirstVersionConditionModel", "CompareFieldValue": "#/components/schemas/CompareFieldValueConditionModel" } } }, "description": "Collection of conditions to add or update. When provided, replaces the entire conditions collection." } }, "description": "Collection wrapper for file process conditions, supporting add/update operations." }, "FileProcessingCompletedRuleConditionModel": { "title": "File processing completed rule condition model", "type": "object", "properties": { "index": { "type": "integer", "description": "Index of the condition within the rule's condition collection", "format": "int32" }, "conditionType": { "description": "Type of condition to be evaluated.", "$ref": "#/components/schemas/RuleConditionDataType" } }, "description": "Model for FileProcessingCompleted rule condition" }, "FileProcessingCompletedRuleConditionNonResource": { "title": "File processing completed rule condition non resource", "type": "object", "properties": { "index": { "type": "integer", "description": "Index of a rule condition in collection", "format": "int32" }, "conditionType": { "description": "Data type of this rule condition", "$ref": "#/components/schemas/RuleConditionDataType" } }, "description": "Representation of File Processing Completed rule condition" }, "FileProcessingState": { "title": "File processing state", "enum": [ "Open", "Exclusive" ], "type": "string", "x-enum-descriptions": [ "File is open for modifications and processing.", "File is exclusively locked during file processing with optional/configurable actions. Prevents modifications until processing completes." ] }, "FileResource": { "title": "File resource", "type": "object", "properties": { "id": { "type": "string", "description": "Identifier for this file.", "format": "uuid" }, "checkedOut": { "type": [ "null", "boolean" ], "description": "Value indicating whether the file is checked out." }, "checkedOutOn": { "type": [ "null", "string" ], "description": "Checked out on date in UTC time.", "format": "date-time" }, "watermarkId": { "type": "string", "description": "Watermark id.", "format": "uuid" }, "watermarkType": { "description": "Watermark type.", "$ref": "#/components/schemas/FileWatermarkType" }, "createdOn": { "type": "string", "description": "Creation datetime in UTC time.", "format": "date-time" }, "_links": { "type": "object", "properties": { "preview": { "description": "Relation to an image with the size of a preview.", "$ref": "#/components/schemas/Link" }, "thumbnail": { "description": "Relation to an image with the size of a thumbnail.", "$ref": "#/components/schemas/Link" }, "fileVersions": { "description": "Relation to a collection of fileversions.", "$ref": "#/components/schemas/Link" }, "latestVersion": { "description": "Relation to the latest fileversion.", "$ref": "#/components/schemas/Link" }, "fields": { "description": "Relation to a collection of fields.", "$ref": "#/components/schemas/Link" }, "checkedOutBy": { "description": "Relation to the user who checked out this file.", "$ref": "#/components/schemas/Link" }, "watermark": { "description": "Relation to the file watermark.", "$ref": "#/components/schemas/Link" }, "createdBy": { "description": "Relation to the user who created this file.", "$ref": "#/components/schemas/Link" }, "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "preview": { "description": "Relation to an image with the size of a preview. Embed via a \"select-file: preview\" header.", "$ref": "#/components/schemas/ImageResource" }, "thumbnail": { "description": "Relation to an image with the size of a thumbnail. Embed via a \"select-file: thumbnail\" header.", "$ref": "#/components/schemas/ImageResource" }, "fileVersions": { "description": "Relation to a collection of fileversions. Embed via a \"select-file: fileVersions\" header.", "$ref": "#/components/schemas/FileCollectionResource" }, "latestVersion": { "description": "Relation to the latest fileversion. Embed via a \"select-file: latestVersion\" header.", "$ref": "#/components/schemas/FileVersionResource" }, "fields": { "description": "Relation to a collection of fields. Embed via a \"select-file: fields\" header.", "$ref": "#/components/schemas/FieldCollectionResource" }, "checkedOutBy": { "description": "Relation to the user who checked out this file. Embed via a \"select-file: checkedOutBy\" header.", "$ref": "#/components/schemas/UserResource" }, "watermark": { "description": "Relation to the file watermark. Embed via a \"select-file: watermark\" header.", "$ref": "#/components/schemas/WatermarkResource" }, "createdBy": { "description": "Relation to the user who created this file. Embed via a \"select-file: createdBy\" header.", "$ref": "#/components/schemas/UserResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "A binary file attached to a record (e.g. the actual image, video, or document). A record can have multiple files, and each file keeps its own version history as file versions." }, "FileState": { "title": "File state", "enum": [ "Available", "Processing" ], "type": "string", "x-enum-descriptions": [ "Normal file, File is available and in the proper 'store'", "File is still in processing, file has defered operations pending. As in previews and thumbs and other meta" ] }, "FileTypeActionCollectionModel": { "title": "File type action collection model", "type": "object", "properties": { "addOrUpdate": { "type": "array", "items": { "$ref": "#/components/schemas/FileTypeActionModel" }, "description": "The catalog actions to add or update." }, "remove": { "type": "array", "items": { "$ref": "#/components/schemas/FileTypeActionModel" }, "description": "The catalog actions to remove." } }, "description": "Collection of catalog actions to add, update, or remove for a file type." }, "FileTypeActionModel": { "title": "File type action model", "type": "object", "properties": { "name": { "type": "string", "description": "The name of the catalog action." }, "isCritical": { "type": "boolean", "description": "Whether this catalog action is critical, i.e. must succeed for the file to be catalogable." }, "id": { "type": "string", "description": "The identifier of this action, which is its name." } }, "description": "A catalog action for a file type." }, "FileTypeActionNonResource": { "title": "File type action non resource", "type": "object", "properties": { "name": { "type": "string", "description": "FileTypeAction's name." }, "isCritical": { "type": "boolean", "description": "FileTypeAction's is critical flag." } }, "description": "Provides language-dependent file type action for file type" }, "FileTypeConditionModel": { "title": "File type condition model", "type": "object", "properties": { "fileTypeIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Array of file type IDs" }, "conditionType": { "description": "The type of condition. Determines which additional properties apply.", "$ref": "#/components/schemas/FileProcessConditionDataType" } }, "description": "Model for FileType condition - checks if the file is of specific type(s)" }, "FileTypeCreateCommand": { "title": "File type create command", "type": "object", "properties": { "name": { "type": "string", "description": "The name of the file type." }, "kind": { "type": "string", "description": "The kind of the file type (e.g. Image, Video, Document)." }, "extension": { "type": "string", "description": "The file extension associated with this file type." }, "mimeType": { "type": "string", "description": "The MIME type associated with this file type." }, "thumbnail": { "type": "string", "description": "The thumbnail used to represent this file type." }, "icon": { "type": "string", "description": "The icon used to represent this file type." }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelModel" }, "description": "Multi-language labels for the name of this file type." }, "registeredFields": { "description": "The fields registered for this file type. Use AddOrUpdate to add or update, or Remove to remove.", "$ref": "#/components/schemas/EditableIdCollectionModel" }, "registeredFieldGroups": { "description": "The field groups registered for this file type. Use AddOrUpdate to add or update, or Remove to remove.", "$ref": "#/components/schemas/EditableIdCollectionModel" }, "engineFormat": { "type": "string", "description": "The engine format used to process files of this type." }, "isCatalogable": { "type": "boolean", "description": "Whether files of this type can be cataloged." }, "catalogActions": { "description": "The catalog actions for this file type. Use AddOrUpdate to add or update, or Remove to remove.", "$ref": "#/components/schemas/FileTypeActionCollectionModel" }, "mediaEngines": { "description": "The media engines used for this file type. Use AddOrUpdate to add or update, or Remove to remove.", "$ref": "#/components/schemas/EditableStringIdCollectionModel" }, "previewFormat": { "type": "string", "description": "The preview format used for this file type." }, "previewPlayers": { "description": "The preview players used for this file type. Use AddOrUpdate to add or update, or Remove to remove.", "$ref": "#/components/schemas/EditableStringIdCollectionModel" }, "previewRequired": { "type": "boolean", "description": "Whether a preview is required for files of this type." }, "previewKeepDimensions": { "type": "boolean", "description": "Whether the preview should keep the original dimensions." }, "supportAssetResize": { "type": "boolean", "description": "Whether asset resize is supported for this file type." }, "supportAssetWatermark": { "type": "boolean", "description": "Whether asset watermarking is supported for this file type." }, "preferredExtension": { "type": "boolean", "description": "Whether this file type's extension is the preferred one for its kind." }, "tag": { "type": "string", "description": "The tag of the file type." } }, "description": "Command to create a new file type." }, "FileTypeEditCommand": { "title": "File type edit command", "type": "object", "properties": { "name": { "type": "string", "description": "The name of the file type." }, "kind": { "type": "string", "description": "The kind of the file type (e.g. Image, Video, Document)." }, "extension": { "type": "string", "description": "The file extension associated with this file type." }, "mimeType": { "type": "string", "description": "The MIME type associated with this file type." }, "thumbnail": { "type": "string", "description": "The thumbnail used to represent this file type." }, "icon": { "type": "string", "description": "The icon used to represent this file type." }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelModel" }, "description": "Multi-language labels for the name of this file type." }, "registeredFields": { "description": "The fields registered for this file type. Use AddOrUpdate to add or update, or Remove to remove.", "$ref": "#/components/schemas/EditableIdCollectionModel" }, "registeredFieldGroups": { "description": "The field groups registered for this file type. Use AddOrUpdate to add or update, or Remove to remove.", "$ref": "#/components/schemas/EditableIdCollectionModel" }, "engineFormat": { "type": "string", "description": "The engine format used to process files of this type." }, "isCatalogable": { "type": "boolean", "description": "Whether files of this type can be cataloged." }, "catalogActions": { "description": "The catalog actions for this file type. Use AddOrUpdate to add or update, or Remove to remove.", "$ref": "#/components/schemas/FileTypeActionCollectionModel" }, "mediaEngines": { "description": "The media engines used for this file type. Use AddOrUpdate to add or update, or Remove to remove.", "$ref": "#/components/schemas/EditableStringIdCollectionModel" }, "previewFormat": { "type": "string", "description": "The preview format used for this file type." }, "previewPlayers": { "description": "The preview players used for this file type. Use AddOrUpdate to add or update, or Remove to remove.", "$ref": "#/components/schemas/EditableStringIdCollectionModel" }, "previewRequired": { "type": "boolean", "description": "Whether a preview is required for files of this type." }, "previewKeepDimensions": { "type": "boolean", "description": "Whether the preview should keep the original dimensions." }, "supportAssetResize": { "type": "boolean", "description": "Whether asset resize is supported for this file type." }, "supportAssetWatermark": { "type": "boolean", "description": "Whether asset watermarking is supported for this file type." }, "preferredExtension": { "type": "boolean", "description": "Whether this file type's extension is the preferred one for its kind." }, "tag": { "type": "string", "description": "The tag of the file type." } }, "description": "Command to edit an existing file type." }, "FileTypeFacetModel": { "title": "File type facet model", "type": "object", "properties": { "maximumFacetValues": { "type": [ "null", "integer" ], "description": "Maximum number of facet values returned.", "format": "int32" }, "filters": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Filters allow you to limit the hits returned without affecting facets. If filters are specified, the aggregated counts in the facets remain the same. However, only records that match the filter criteria specified in the facet are returned. The parameter type of the filters depends on the facet type, but is always the same type as explicitValues/explicitRanges." }, "explicitValues": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "A list of values. When specified, only shows facets corresponding to the specified values. If not specified, all occurring values are included." }, "explicitRanges": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Allows for the explicit specification of ranges to include in the facet. If explicitRanges is specified, you cannot specify rangeStart, rangeEnd, or spans (on the concrete range facet type)." }, "name": { "type": "string", "description": "A textual identifier for this facet, used only by the client to correlate requests with responses." }, "type": { "enum": [ "NumericField", "NumericFieldRange", "Classification", "CreatedBy", "ModifiedBy", "FileType", "OptionListField", "TextField", "DateTimeFieldRange", "DateFieldRange", "CreatedOn", "ModifiedOn", "TimeFieldRange", "TextListField", "ContentType", "ClassificationListField", "DateFieldRangeFilter", "NumericFieldRangeFilter" ], "type": "string", "description": "Type of the facet. Depending on facet type, different parameters, combinations of parameters and parameter types are possible." } }, "description": "Facets on file type. explicitValues is a list of file type ids." }, "FileTypePagedCollectionResource": { "title": "File type paged collection resource", "type": "object", "properties": { "pageNumber": { "type": [ "null", "integer" ], "description": "The current page of this paged collection.", "format": "int32" }, "pageSize": { "type": [ "null", "integer" ], "description": "The current page size of this paged collection.", "format": "int32" }, "skip": { "type": [ "null", "integer" ], "description": "The current skip size of this paged collection.", "format": "int32" }, "take": { "type": [ "null", "integer" ], "description": "The current take size of this paged collection.", "format": "int32" }, "totalCount": { "type": "integer", "description": "The total count of items in this paged collection, not just on the current page.", "format": "int64" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/FileTypeResource" }, "description": "One page of this paged collection, which is a subcollection of the complete collection." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" }, "first": { "description": "A link to the first page of this paged collection.", "$ref": "#/components/schemas/Link" }, "prev": { "description": "A link to the previous page of this paged collection.", "$ref": "#/components/schemas/Link" }, "next": { "description": "A link to the next page of this paged collection.", "$ref": "#/components/schemas/Link" }, "last": { "description": "A link to the last page of this paged collection.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of a paged collection of file types" }, "FileTypeResource": { "title": "File type resource", "type": "object", "properties": { "id": { "type": "string", "description": "Identifier.", "format": "uuid" }, "name": { "type": "string", "description": "Name of the file type" }, "kind": { "type": "string", "description": "Kind of the file type." }, "extension": { "type": "string", "description": "Extension of the file type." }, "mimeType": { "type": "string", "description": "Mime type of the file type." }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelNonResource" }, "description": "Collection of the labels" }, "registeredFields": { "type": "array", "items": { "$ref": "#/components/schemas/RegisteredFieldNonResource" }, "description": "A collection of Registered Field items." }, "registeredFieldGroups": { "type": "array", "items": { "$ref": "#/components/schemas/RegisteredFieldGroupNonResource" }, "description": "A collection of Registered Field Group items." }, "engineFormat": { "type": "string", "description": "Engine format" }, "isCatalogable": { "type": "boolean", "description": "Indicates whether files of this type can be catalogued." }, "catalogActions": { "type": "array", "items": { "$ref": "#/components/schemas/FileTypeActionNonResource" }, "description": "Collection of the catalog actions" }, "mediaEngines": { "type": "array", "items": { "type": "string" }, "description": "Collection of media engines" }, "previewFormat": { "type": "string", "description": "Preview formats." }, "previewPlayers": { "type": "array", "items": { "type": "string" }, "description": "Collection of preview players." }, "previewRequired": { "type": "boolean", "description": "Indicates whether a preview is required for files of this type." }, "previewKeepDimensions": { "type": "boolean", "description": "Dimensions the preview has to keep" }, "supportAssetResize": { "type": "boolean", "description": "Permission to resize" }, "supportAssetWatermark": { "type": "boolean", "description": "Permission to add a watermark" }, "preferredExtension": { "type": "boolean", "description": "Preferred extension." }, "tag": { "type": "string", "description": "Value for the Tag of this object. The value of this property should be a valid XML. An empty string will be automatically converted to null. Opt-in: returned only when requested. Include via a \"select-filetype: Tag\" header." }, "modifiedOn": { "type": "string", "description": "Last modification datetime in UTC time.", "format": "date-time" }, "createdOn": { "type": "string", "description": "Creation datetime in UTC time.", "format": "date-time" }, "_links": { "type": "object", "properties": { "icon": { "description": "Relation to an image with the size of a icon.", "$ref": "#/components/schemas/Link" }, "thumbnail": { "description": "Relation to an image with the size of a thumbnail.", "$ref": "#/components/schemas/Link" }, "modifiedBy": { "description": "Relation to the user who modified this file type.", "$ref": "#/components/schemas/Link" }, "createdBy": { "description": "Relation to the user who created this file type.", "$ref": "#/components/schemas/Link" }, "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "icon": { "description": "Relation to an image with the size of a icon. Embed via a \"select-filetype: icon\" header.", "$ref": "#/components/schemas/ImageResource" }, "thumbnail": { "description": "Relation to an image with the size of a thumbnail. Embed via a \"select-filetype: thumbnail\" header.", "$ref": "#/components/schemas/ImageResource" }, "modifiedBy": { "description": "Relation to the user who modified this file type. Embed via a \"select-filetype: modifiedBy\" header.", "$ref": "#/components/schemas/UserResource" }, "createdBy": { "description": "Relation to the user who created this file type. Embed via a \"select-filetype: createdBy\" header.", "$ref": "#/components/schemas/UserResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "A configured file type (e.g. JPEG, PDF) defining how files of that kind are processed - media engines, previews, catalog actions, and supported operations such as resizing or watermarking." }, "FileVersionAnnotationInfoNonResource": { "title": "File version annotation info non resource", "type": "object", "properties": { "totalCount": { "type": [ "null", "integer" ], "description": "Total number of found annotations", "format": "int32" }, "annotations": { "type": "array", "items": { "type": "string" }, "description": "Annotations for the file version" } }, "description": "Representation of a File Version's Annotation Info" }, "FileVersionCheckResultCollectionResource": { "title": "File version check result collection resource", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/FileVersionCheckResultResource" }, "description": "A collection of resource items." }, "_links": { "type": "object", "properties": { "checkResults": { "description": "Relation to the check results in this collection.", "$ref": "#/components/schemas/Link" }, "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "checkResults": { "description": "Relation to the check results in this collection. Embed via a \"select-fileversioncheckresultcollection: checkResults\" header.", "$ref": "#/components/schemas/FileVersionCheckResultResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "Representation of a File Version Check Result Collection" }, "FileVersionCheckResultFindingCollectionResource": { "title": "File version check result finding collection resource", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/FileVersionCheckResultFindingResource" }, "description": "A collection of resource items." }, "_links": { "type": "object", "properties": { "findings": { "description": "Relation to the findings in this collection.", "$ref": "#/components/schemas/Link" }, "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "findings": { "description": "Relation to the findings in this collection. Embed via a \"select-fileversioncheckresultfindingcollection: findings\" header.", "$ref": "#/components/schemas/FileVersionCheckResultFindingResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "Representation of a File Version Check Result Finding Collection" }, "FileVersionCheckResultFindingResource": { "title": "File version check result finding resource", "type": "object", "properties": { "occurrence": { "type": "integer", "description": "Occurrence number for this finding.", "format": "int32" }, "fileVersionCheckId": { "type": "string", "description": "File version check identifier for this finding.", "format": "uuid" }, "finding": { "type": "string", "description": "Flagged content itself, e.g. a specific flagged sentence. Does not support Markdown." }, "explanation": { "type": "string", "description": "Explanation for this finding. Supports Markdown, including links." }, "recommendation": { "type": "string", "description": "Recommendation for this finding. Supports Markdown, including links." }, "additionalData": { "type": "string", "description": "Additional data for this finding." }, "outcome": { "type": "string", "description": "Outcome of this finding." }, "_links": { "type": "object", "properties": { "self": { "description": "Link to the current resource", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of a File Version Check Result Finding" }, "FileVersionCheckResultResource": { "title": "File version check result resource", "type": "object", "properties": { "id": { "type": "string", "description": "Identifier for this check result.", "format": "uuid" }, "fileVersionId": { "type": "string", "description": "File version identifier for this check result.", "format": "uuid" }, "checkId": { "type": "string", "description": "Check identifier for this check result.", "format": "uuid" }, "description": { "type": "string", "description": "Summary the user sees first, e.g. \"Three issues were found\". Best practice: immediately after starting an external check, create a result with outcome \"info\" and a description like \"In Progress\" so the user knows the request was received; when the check completes, PUT that same result with the final outcome and description, rather than creating a new one." }, "outcome": { "type": "string", "description": "Outcome of this check result: pass, fail, warning, or info. If left unset, it is derived from this result's findings: 0 findings -> no badge shown; 1+ fail -> red badge (count of fail+warn); 1+ warn, 0 fail -> orange badge (count of warnings); 1+ pass, 0 fail/warn -> green badge (count of passes); 1+ info, 0 fail/warn/pass -> gray \"Info\" badge. Setting outcome explicitly overrides this rollup." }, "createdById": { "type": "string", "description": "ID of the user who created this check result.", "format": "uuid" }, "createdOn": { "type": "string", "description": "Creation datetime in UTC time.", "format": "date-time" }, "_links": { "type": "object", "properties": { "findings": { "description": "Relation to the findings for this check result.", "$ref": "#/components/schemas/Link" }, "check": { "description": "Relation to the check definition for this check result.", "$ref": "#/components/schemas/Link" }, "createdBy": { "description": "Relation to the user who created this check result.", "$ref": "#/components/schemas/Link" }, "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "findings": { "description": "Relation to the findings for this check result. Embed via a \"select-fileversioncheckresult: findings\" header.", "$ref": "#/components/schemas/FileVersionCheckResultFindingCollectionResource" }, "check": { "description": "Relation to the check definition for this check result. Embed via a \"select-fileversioncheckresult: check\" header.", "$ref": "#/components/schemas/CheckResource" }, "createdBy": { "description": "Relation to the user who created this check result. Embed via a \"select-fileversioncheckresult: createdBy\" header.", "$ref": "#/components/schemas/UserResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "The result of running a check against a file version - the main object you write to per check run. Every run should create one of these, even with no detailed findings; this is mandatory." }, "FileVersionCollectionResource": { "title": "File version collection resource", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/FileVersionResource" }, "description": "A collection of resource items." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of a non-paged collection of file versions" }, "FileVersionCompareInsightPayload": { "title": "File version compare insight payload", "type": "object", "properties": { "contentCoachId": { "type": "integer", "description": "Id of the content coach that generated this compare insight.", "format": "int32" }, "promptLogId": { "type": [ "null", "integer" ], "description": "Id of the prompt log associated with this compare insight.", "format": "int32" }, "degree": { "type": "integer", "description": "Degree of this compare insight.", "format": "int32" }, "summary": { "type": "string", "description": "Summary of this compare insight." }, "highlights": { "type": "string", "description": "Highlights of this compare insight." }, "runDate": { "type": "string", "description": "Date and time this compare insight was run.", "format": "date-time" } }, "description": "AI-generated compare insight to persist for a file version, produced by a Content Coach run." }, "FileVersionDuplicateInfoNonResource": { "title": "File version duplicate info non resource", "type": "object", "properties": { "status": { "$ref": "#/components/schemas/DuplicateStatus" }, "totalCount": { "type": [ "null", "integer" ], "description": "Total number of found duplicates", "format": "int32" }, "duplicates": { "type": "array", "items": { "$ref": "#/components/schemas/Duplicate" }, "description": "Duplicates of the file version to which the user has (read) access" }, "detectionMode": { "enum": [ "FileNameAndContent", "FileName", "FileContent" ], "type": "string", "description": "Returns the Mode used to determine if files are a duplicate" } }, "description": "Representation of a File Version's Duplicate Info" }, "FileVersionMetadataNonResource": { "title": "File version metadata non resource", "type": "object", "properties": { "contentType": { "type": "string", "description": "Label of the additional file" }, "value": { "type": "string", "description": "File name of the additional file" } }, "description": "Representation of a File Version Metadata" }, "FileVersionModel": { "title": "File version model", "type": "object", "properties": { "id": { "type": "string", "description": "Identifier of the file version. When adding a new file version, pass the upload token returned after uploading the file; when editing an existing file version, pass its GUID." }, "fileName": { "type": "string", "description": "File name." }, "tag": { "type": "string", "description": "Tag used to distinguish or categorize this file version." }, "versionLabel": { "type": "string", "description": "Version label of the file version." }, "comment": { "type": "string", "description": "Comment associated with the file version." }, "additionalFiles": { "$ref": "#/components/schemas/AdditionalFilesModel" }, "watermarkType": { "description": "Watermark type applied to this file version.", "$ref": "#/components/schemas/FileVersionWatermarkType" }, "watermarkId": { "type": "string", "description": "Identifier of the watermark to apply, when WatermarkType is UseSpecified." }, "previews": { "$ref": "#/components/schemas/FilePreviewsModel" }, "publicationItems": { "type": "array", "items": { "$ref": "#/components/schemas/RecordsPublicationItemModel" }, "description": "Publication items associated with this file version." }, "preventDownload": { "type": "boolean", "description": "When set, prevents this file version from being downloaded." }, "aIInfluenced": { "description": "Indicates whether AI was involved in creating or influencing this file version.", "$ref": "#/components/schemas/AIInfluenced" } }, "description": "A version of a file." }, "FileVersionPagedCollectionResource": { "title": "File version paged collection resource", "type": "object", "properties": { "pageNumber": { "type": [ "null", "integer" ], "description": "The current page of this paged collection.", "format": "int32" }, "pageSize": { "type": [ "null", "integer" ], "description": "The current page size of this paged collection.", "format": "int32" }, "skip": { "type": [ "null", "integer" ], "description": "The current skip size of this paged collection.", "format": "int32" }, "take": { "type": [ "null", "integer" ], "description": "The current take size of this paged collection.", "format": "int32" }, "totalCount": { "type": "integer", "description": "The total count of items in this paged collection, not just on the current page.", "format": "int64" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/FileVersionResource" }, "description": "One page of this paged collection, which is a subcollection of the complete collection." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" }, "first": { "description": "A link to the first page of this paged collection.", "$ref": "#/components/schemas/Link" }, "prev": { "description": "A link to the previous page of this paged collection.", "$ref": "#/components/schemas/Link" }, "next": { "description": "A link to the next page of this paged collection.", "$ref": "#/components/schemas/Link" }, "last": { "description": "A link to the last page of this paged collection.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of a paged collection of file versions" }, "FileVersionPermissionsResource": { "title": "File version permissions resource", "type": "object", "properties": { "canDownload": { "type": "boolean", "description": "Indicates whether the current user has download permissions on this object." }, "canDelete": { "type": "boolean", "description": "Indicates whether the current user can delete this file version" }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of the permissions on a file version" }, "FileVersionResource": { "title": "File version resource", "type": "object", "properties": { "id": { "type": "string", "description": "Id of the file version.", "format": "uuid" }, "versionLabel": { "type": "string", "description": "Text that describes this file version. It is not required, can be a maximum of 50 characters long and has to be unique for all the file versions." }, "versionNumber": { "type": "integer", "description": "Version number of this version. The first version is always version 1. This number is automatically incremented when a new version is added.", "format": "int32" }, "fileName": { "type": "string", "description": "File name of this file version." }, "fileCreatedOn": { "type": "string", "description": "Creation datetime of the physical asset file, in UTC time.", "format": "date-time" }, "fileModifiedOn": { "type": [ "null", "string" ], "description": "Date/time in UTC time on which the file version was last modified.", "format": "date-time" }, "metadata": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/FileVersionMetadataNonResource" }, "description": "Collection containing the metadata of this file version. Opt-in: returned only when requested. Include via a \"select-fileversion: Metadata\" header." }, "fileSize": { "type": [ "null", "integer" ], "description": "Get the file size of this file version.", "format": "int64" }, "fileExtension": { "type": "string", "description": "File extension of this file version. An empty string will be returned if this file version does not have a file extension." }, "comment": { "type": "string", "description": "Comment on this file version." }, "crc32": { "type": "integer", "description": "CRC32 checksum of this file version. This checksum is not immediately calculated when ingesting, so it might not yet be available.", "format": "int32" }, "sha256": { "type": "string", "description": "SHA-256 hash of this file version. This value is calculated asynchronously during ingestion and might not yet be available." }, "content": { "type": "string", "description": "Value of the Content of this object. The value of this property should be a valid XML. An empty string will be automatically converted to null. Opt-in: returned only when requested. Include via a \"select-fileversion: Content\" header." }, "tag": { "type": "string", "description": "Value for the Tag of this object. The value of this property should be a valid XML. An empty string will be automatically converted to null. Opt-in: returned only when requested. Include via a \"select-fileversion: Tag\" header." }, "preventDownload": { "type": [ "null", "boolean" ], "description": "Indicates whether the download of this file version is prevented." }, "isLatest": { "type": "boolean", "description": "Indicates if this version is the latest." }, "fileProcessingState": { "description": "File processing state of this file version.", "$ref": "#/components/schemas/FileProcessingState" }, "aIInfluenced": { "description": "Indicates if this version has content generated by AI.", "$ref": "#/components/schemas/AIInfluenced" }, "duplicateInfo": { "description": "Duplicate info of this file version Opt-in: returned only when requested. Include via a \"select-fileversion: DuplicateInfo\" header.", "$ref": "#/components/schemas/FileVersionDuplicateInfoNonResource" }, "publicationItems": { "type": "array", "items": { "$ref": "#/components/schemas/PublicationItemNonResource" }, "description": "A file version can be a publication (a set of other file versions, e.g. the pages of a document) or a publication item (one of those pages). This is the publication's ordered list of items. Opt-in: returned only when requested via a \"select-fileversion: PublicationItems\" header. It can be set through a PUT or POST on /record/{recordId}, targeting this file version's \"publicationitems\" property; each item's \"targetFileVersionId\" must reference an existing file version. Setting this property always replaces the complete collection. Opt-in: returned only when requested. Include via a \"select-fileversion: PublicationItems\" header." }, "publications": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Collection of all the publications this file version is an item of. Opt-in: returned only when requested. Include via a \"select-fileversion: Publications\" header." }, "annotationInfo": { "description": "Annotation info of this file version Opt-in: returned only when requested. Include via a \"select-fileversion: AnnotationInfo\" header.", "$ref": "#/components/schemas/FileVersionAnnotationInfoNonResource" }, "watermarkId": { "type": "string", "description": "Watermark id.", "format": "uuid" }, "watermarkType": { "description": "Watermark type.", "$ref": "#/components/schemas/FileVersionWatermarkType" }, "fileState": { "description": "State of the file.", "$ref": "#/components/schemas/FileState" }, "hasSmartActionFindings": { "type": [ "null", "boolean" ], "description": "Boolean indicating if there are smart action findings for this file version." }, "createdOn": { "type": "string", "description": "Creation datetime in UTC time.", "format": "date-time" }, "_links": { "type": "object", "properties": { "fileType": { "description": "Relation to a file type.", "$ref": "#/components/schemas/Link" }, "filePreviews": { "description": "Relation to a collection of file previews.", "$ref": "#/components/schemas/Link" }, "masterFilePreview": { "description": "Relation to the preview of the masterfile.", "$ref": "#/components/schemas/Link" }, "preview": { "description": "Relation to an image with the size of a preview.", "$ref": "#/components/schemas/Link" }, "thumbnail": { "description": "Relation to an image with the size of a thumbnail.", "$ref": "#/components/schemas/Link" }, "additionalFiles": { "description": "Relation to a collection of additional files.", "$ref": "#/components/schemas/Link" }, "renditions": { "description": "Relation to the file version renditions.", "$ref": "#/components/schemas/Link" }, "publicLinks": { "description": "Relation to the file version public links.", "$ref": "#/components/schemas/Link" }, "watermark": { "description": "Relation to the file version watermark.", "$ref": "#/components/schemas/Link" }, "permissions": { "description": "Relation to the permissions.", "$ref": "#/components/schemas/Link" }, "usedIn": { "description": "Relation to publications or publication items of a version.", "$ref": "#/components/schemas/Link" }, "contains": { "description": "Relation to publications or publication items of a version.", "$ref": "#/components/schemas/Link" }, "createdBy": { "description": "Relation to the user who created this file version.", "$ref": "#/components/schemas/Link" }, "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "fileType": { "description": "Relation to a file type. Embed via a \"select-fileversion: fileType\" header.", "$ref": "#/components/schemas/FileTypeResource" }, "filePreviews": { "description": "Relation to a collection of file previews. Embed via a \"select-fileversion: filePreviews\" header.", "$ref": "#/components/schemas/FilePreviewCollectionResource" }, "masterFilePreview": { "description": "Relation to the preview of the masterfile. Embed via a \"select-fileversion: masterFilePreview\" header.", "$ref": "#/components/schemas/FilePreviewResource" }, "preview": { "description": "Relation to an image with the size of a preview. Embed via a \"select-fileversion: preview\" header.", "$ref": "#/components/schemas/ImageResource" }, "thumbnail": { "description": "Relation to an image with the size of a thumbnail. Embed via a \"select-fileversion: thumbnail\" header.", "$ref": "#/components/schemas/ImageResource" }, "additionalFiles": { "description": "Relation to a collection of additional files. Embed via a \"select-fileversion: additionalFiles\" header.", "$ref": "#/components/schemas/AdditionalFileCollectionResource" }, "renditions": { "description": "Relation to the file version renditions. Embed via a \"select-fileversion: renditions\" header.", "$ref": "#/components/schemas/RenditionCollectionResource" }, "publicLinks": { "description": "Relation to the file version public links. Embed via a \"select-fileversion: publicLinks\" header.", "$ref": "#/components/schemas/PublicLinkCollectionResource" }, "watermark": { "description": "Relation to the file version watermark. Embed via a \"select-fileversion: watermark\" header.", "$ref": "#/components/schemas/WatermarkResource" }, "permissions": { "description": "Relation to the permissions. Embed via a \"select-fileversion: permissions\" header.", "$ref": "#/components/schemas/FileVersionPermissionsResource" }, "usedIn": { "description": "Relation to publications or publication items of a version. Embed via a \"select-fileversion: usedIn\" header.", "$ref": "#/components/schemas/LinkedVersionInfoCollectionResource" }, "contains": { "description": "Relation to publications or publication items of a version. Embed via a \"select-fileversion: contains\" header.", "$ref": "#/components/schemas/LinkedVersionInfoCollectionResource" }, "createdBy": { "description": "Relation to the user who created this file version. Embed via a \"select-fileversion: createdBy\" header.", "$ref": "#/components/schemas/UserResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "A specific saved revision of a file's content - replacing or re-uploading a file creates a new version while preserving earlier ones for history. New versions are created by submitting a files.addOrUpdate[].versions.addOrUpdate[] entry on POST /record or PUT /record/:id; there is no standalone create endpoint under file version itself." }, "FileVersionWatermarkType": { "title": "File version watermark type", "enum": [ "None", "InheritFromFile", "UseSpecified", "UseSetting" ], "type": "string", "x-enum-descriptions": [ "No watermark is applied.", "The watermark is inherited from the file.", "A specific watermark, identified separately, is used.", "The watermark configured in settings is used." ] }, "FileVersionsModel": { "title": "File versions model", "type": "object", "properties": { "addOrUpdate": { "type": "array", "items": { "$ref": "#/components/schemas/FileVersionModel" }, "description": "The file versions to add or update." }, "remove": { "type": "array", "items": { "$ref": "#/components/schemas/FileVersionModel" }, "description": "The file versions to remove." } }, "description": "Collection of file versions to add, update, or remove on a file." }, "FileWatermarkType": { "title": "File watermark type", "enum": [ "None", "UseSetting", "UseSpecified" ], "type": "string", "x-enum-descriptions": [ "No watermark is applied.", "The watermark configured in the .watermarkName setting is used.", "A specific watermark, identified separately, is used." ] }, "FilesModel": { "title": "Files model", "type": "object", "properties": { "master": { "type": "string", "description": "Identifier of the file to use as the master file." }, "addOrUpdate": { "type": "array", "items": { "$ref": "#/components/schemas/FileModel" }, "description": "The files to add or update." }, "remove": { "type": "array", "items": { "$ref": "#/components/schemas/FileModel" }, "description": "The files to remove." } }, "description": "Collection of files to add, update, or remove on a record." }, "FtpConnectionType": { "title": "Ftp connection type", "enum": [ "Normal", "ImplicitEncryption", "ExplicitSSLEncryption", "ExplicitTLSEncryption" ], "type": "string" }, "FtpOrderCreateCommand": { "title": "Ftp order create command", "type": "object", "properties": { "ftpHostname": { "type": "string", "description": "Host name or address of the FTP server to connect to." }, "ftpUsername": { "type": "string", "description": "User name used to authenticate with the FTP server." }, "ftpPassword": { "type": "string", "description": "Password used to authenticate with the FTP server." }, "ftpPort": { "type": [ "null", "integer" ], "description": "Port number of the FTP server to connect to.", "format": "int32" }, "ftpDirectory": { "type": "string", "description": "Directory on the FTP server where files are delivered." }, "proxyHostname": { "type": "string", "description": "Host name or address of the proxy server to connect through." }, "proxyUsername": { "type": "string", "description": "User name used to authenticate with the proxy server." }, "proxyPassword": { "type": "string", "description": "Password used to authenticate with the proxy server." }, "proxyPort": { "type": [ "null", "integer" ], "description": "Port number of the proxy server to connect through.", "format": "int32" }, "passiveTransfer": { "type": "boolean", "description": "When set, uses passive mode for the FTP data transfer." }, "connectionType": { "description": "Security mode used when connecting to the FTP server. See FtpConnectionType.", "$ref": "#/components/schemas/OrdersFtpConnectionType" }, "deliveryLocation": { "type": "string", "description": "Location where the order output is delivered." }, "includeTargets": { "type": "boolean", "description": "When set, includes the resolved order targets in the response." }, "disableProcessing": { "type": "string", "description": "When set, disables further processing of the order." }, "creatorEmail": { "type": "string", "description": "Email address of the user the job is created on behalf of." }, "disableNotification": { "type": "boolean", "description": "When set to true, suppresses notifications for this job." }, "earliestStartDate": { "type": [ "null", "string" ], "description": "Earliest date and time at which the job is allowed to start executing.", "format": "date-time" }, "priority": { "enum": [ "High", "Medium" ], "type": "string", "description": "Priority used to schedule this job relative to other maintenance jobs." }, "type": { "enum": [ "Classification", "Record", "ExportAuditTrail", "BulkRecord", "AcceptDownloadOrderAgreement", "BulkCollection", "ExportContentItemsList" ], "type": "string", "description": "Type of maintenance job to create." }, "targets": { "type": "array", "items": { "$ref": "#/components/schemas/OrderTargetModel" }, "description": "Targets the job's actions are applied to." }, "actions": { "type": "array", "items": { "$ref": "#/components/schemas/ActionModel" }, "description": "Actions to execute for each target of this job." }, "title": { "type": "string", "description": "Title of the job. For a download or contact-sheet order this is shown on the Downloads page in Content Workspace; if omitted, it defaults to the file name, or \"X items\" when multiple files were ordered. Either plain text, or a JSON string of the form {\"studioName\":\"...\",\"moduleName\":\"...\",\"translationKey\":\"...\"} to look up a translated value for non-English users (see the Localization > Translations section of the DAM Administrator Guide for how translations are registered)." }, "description": { "type": "string", "description": "Description of the job. For a download or contact-sheet order this is shown on the Downloads page in Content Workspace; if omitted, it defaults to \"Download\". Accepts the same plain-text-or-translation-key JSON format as Title." }, "errorMode": { "type": "string", "description": "Determines how the job behaves when one of its targets fails to execute." } }, "description": "Payload for creating an order that delivers files to an FTP server." }, "FtpOrderResource": { "title": "Ftp order resource", "type": "object", "properties": { "ftpHostname": { "type": "string", "description": "The FTP hostname" }, "ftpUsername": { "type": "string", "description": "The FTP username" }, "ftpDirectory": { "type": "string", "description": "The FTP directory" }, "ftpPort": { "type": "integer", "description": "The FTP port", "format": "int32" }, "proxyHostname": { "type": "string", "description": "The FTP proxy hostname" }, "proxyUsername": { "type": "string", "description": "The FTP proxy username" }, "proxyPort": { "type": "integer", "description": "The FTP proxy port", "format": "int32" }, "passiveTransfer": { "type": "boolean", "description": "Indicates if passive transfer is enabled" }, "connectionType": { "description": "The FTP connection type.", "$ref": "#/components/schemas/FtpConnectionType" }, "orderType": { "type": "string", "description": "Type of the order" }, "deliveredFiles": { "type": "array", "items": { "type": "string" }, "description": "The files delivered to the client by this order." }, "totalFileSize": { "type": "integer", "description": "Total file size of the delivered files", "format": "int64" }, "creatorEmail": { "type": "string", "description": "E-mail address for this job" }, "disableNotification": { "type": "boolean", "description": "Value indicating whether or not notification is enabled on this job" }, "earliestStartDate": { "type": [ "null", "string" ], "description": "The earliest date in utc time on which this job can be executed.", "format": "date-time" }, "executionTime": { "type": "string", "description": "Time it took for this maintenance job to execute." }, "id": { "type": "string", "description": "Id of this maintenance job.", "format": "uuid" }, "type": { "type": "string", "description": "Name of this maintenance job." }, "priority": { "enum": [ "High", "Medium", "AuditArchiving", "BuildSearchIndex" ], "type": "string", "description": "Priority of this maintenance job." }, "startedOn": { "type": [ "null", "string" ], "description": "Time on which the execution of this maintenance job started in utc time.", "format": "date-time" }, "status": { "enum": [ "Pending", "Success", "Failed", "PartiallyFailed", "Executing", "Cancelled", "Scheduled", "Queued", "AsyncPending", "AsyncExecuting" ], "type": "string", "description": "Status of this maintenance job." }, "message": { "type": [ "null", "string" ], "description": "Error message that describes why this maintenance job failed. Returns null if this maintenance job hasn't been executed yet." }, "failedTargetsCount": { "type": "integer", "description": "Count of the failed targets.", "format": "int32" }, "createdOn": { "type": "string", "description": "Creation datetime in UTC time.", "format": "date-time" }, "_links": { "type": "object", "properties": { "targets": { "description": "Relation to a collection of order targets.", "$ref": "#/components/schemas/Link" }, "createdBy": { "description": "Relation to the user who created this maintenance job.", "$ref": "#/components/schemas/Link" }, "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "targets": { "description": "Relation to a collection of order targets. Embed via a \"select-order: targets\" header.", "$ref": "#/components/schemas/OrderTargetCollectionResource" }, "createdBy": { "description": "Relation to the user who created this maintenance job. Embed via a \"select-ftporder: createdBy\" header.", "$ref": "#/components/schemas/UserResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "Representation of an FTP order." }, "FtpResortOrderCreateCommand": { "title": "Ftp resort order create command", "type": "object", "properties": { "deliveryLocation": { "type": "string", "description": "Location where the order output is delivered." }, "includeTargets": { "type": "boolean", "description": "When set, includes the resolved order targets in the response." }, "disableProcessing": { "type": "string", "description": "When set, disables further processing of the order." }, "creatorEmail": { "type": "string", "description": "Email address of the user the job is created on behalf of." }, "disableNotification": { "type": "boolean", "description": "When set to true, suppresses notifications for this job." }, "earliestStartDate": { "type": [ "null", "string" ], "description": "Earliest date and time at which the job is allowed to start executing.", "format": "date-time" }, "priority": { "enum": [ "High", "Medium" ], "type": "string", "description": "Priority used to schedule this job relative to other maintenance jobs." }, "type": { "enum": [ "Classification", "Record", "ExportAuditTrail", "BulkRecord", "AcceptDownloadOrderAgreement", "BulkCollection", "ExportContentItemsList" ], "type": "string", "description": "Type of maintenance job to create." }, "targets": { "type": "array", "items": { "$ref": "#/components/schemas/OrderTargetModel" }, "description": "Targets the job's actions are applied to." }, "actions": { "type": "array", "items": { "$ref": "#/components/schemas/ActionModel" }, "description": "Actions to execute for each target of this job." }, "title": { "type": "string", "description": "Title of the job. For a download or contact-sheet order this is shown on the Downloads page in Content Workspace; if omitted, it defaults to the file name, or \"X items\" when multiple files were ordered. Either plain text, or a JSON string of the form {\"studioName\":\"...\",\"moduleName\":\"...\",\"translationKey\":\"...\"} to look up a translated value for non-English users (see the Localization > Translations section of the DAM Administrator Guide for how translations are registered)." }, "description": { "type": "string", "description": "Description of the job. For a download or contact-sheet order this is shown on the Downloads page in Content Workspace; if omitted, it defaults to \"Download\". Accepts the same plain-text-or-translation-key JSON format as Title." }, "errorMode": { "type": "string", "description": "Determines how the job behaves when one of its targets fails to execute." } }, "description": "Payload for creating an order that resorts a previously delivered FTP order." }, "FtpResortOrderResource": { "title": "Ftp resort order resource", "type": "object", "properties": { "orderType": { "type": "string", "description": "Type of the order" }, "deliveredFiles": { "type": "array", "items": { "type": "string" }, "description": "The files delivered to the client by this order." }, "totalFileSize": { "type": "integer", "description": "Total file size of the delivered files", "format": "int64" }, "creatorEmail": { "type": "string", "description": "E-mail address for this job" }, "disableNotification": { "type": "boolean", "description": "Value indicating whether or not notification is enabled on this job" }, "earliestStartDate": { "type": [ "null", "string" ], "description": "The earliest date in utc time on which this job can be executed.", "format": "date-time" }, "executionTime": { "type": "string", "description": "Time it took for this maintenance job to execute." }, "id": { "type": "string", "description": "Id of this maintenance job.", "format": "uuid" }, "type": { "type": "string", "description": "Name of this maintenance job." }, "priority": { "enum": [ "High", "Medium", "AuditArchiving", "BuildSearchIndex" ], "type": "string", "description": "Priority of this maintenance job." }, "startedOn": { "type": [ "null", "string" ], "description": "Time on which the execution of this maintenance job started in utc time.", "format": "date-time" }, "status": { "enum": [ "Pending", "Success", "Failed", "PartiallyFailed", "Executing", "Cancelled", "Scheduled", "Queued", "AsyncPending", "AsyncExecuting" ], "type": "string", "description": "Status of this maintenance job." }, "message": { "type": [ "null", "string" ], "description": "Error message that describes why this maintenance job failed. Returns null if this maintenance job hasn't been executed yet." }, "failedTargetsCount": { "type": "integer", "description": "Count of the failed targets.", "format": "int32" }, "createdOn": { "type": "string", "description": "Creation datetime in UTC time.", "format": "date-time" }, "_links": { "type": "object", "properties": { "targets": { "description": "Relation to a collection of order targets.", "$ref": "#/components/schemas/Link" }, "createdBy": { "description": "Relation to the user who created this maintenance job.", "$ref": "#/components/schemas/Link" }, "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "targets": { "description": "Relation to a collection of order targets. Embed via a \"select-order: targets\" header.", "$ref": "#/components/schemas/OrderTargetCollectionResource" }, "createdBy": { "description": "Relation to the user who created this maintenance job. Embed via a \"select-ftpresortorder: createdBy\" header.", "$ref": "#/components/schemas/UserResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "Representation of an FTP resort order." }, "GroupPermissionModel": { "title": "Group permission model", "type": "object", "properties": { "groupId": { "type": [ "null", "string" ], "description": "Identifier of the user group this permission applies to.", "format": "uuid" }, "permission": { "enum": [ "None", "Read", "Modify" ], "type": [ "null", "string" ], "description": "Permission granted to the user group." }, "id": { "type": "string", "description": "Identifier used to match this entry, equal to GroupId.", "format": "uuid" } }, "description": "Permission granted to a user group on a collection." }, "GroupPermissionsModel": { "title": "Group permissions model", "type": "object", "properties": { "addOrUpdate": { "type": "array", "items": { "$ref": "#/components/schemas/GroupPermissionModel" }, "description": "User group permissions to add or update." }, "remove": { "type": "array", "items": { "$ref": "#/components/schemas/GroupPermissionModel" }, "description": "User group permissions to remove." } }, "description": "Collection of user group permissions to add, update, or remove." }, "HasFieldValueChangedRuleConditionModel": { "title": "Has field value changed rule condition model", "type": "object", "properties": { "fieldDefinitionId": { "type": [ "null", "string" ], "description": "Id of the field definition to check", "format": "uuid" }, "index": { "type": "integer", "description": "Index of the condition within the rule's condition collection", "format": "int32" }, "conditionType": { "description": "Type of condition to be evaluated.", "$ref": "#/components/schemas/RuleConditionDataType" } }, "description": "Model for HasFieldValueChanged rule condition" }, "HasFieldValueChangedRuleConditionNonResource": { "title": "Has field value changed rule condition non resource", "type": "object", "properties": { "fieldDefinitionId": { "type": [ "null", "string" ], "description": "Id of the field whose value is watched", "format": "uuid" }, "index": { "type": "integer", "description": "Index of a rule condition in collection", "format": "int32" }, "conditionType": { "description": "Data type of this rule condition", "$ref": "#/components/schemas/RuleConditionDataType" } }, "description": "Representation of Has Field Value Changed rule condition" }, "HelpTextModel": { "title": "Help text model", "type": "object", "properties": { "value": { "type": "string", "description": "Help text value." }, "languageId": { "type": "string", "description": "Identifier of the language this help text is in.", "format": "uuid" } }, "description": "Help text value for a single language." }, "HelpTextNonResource": { "title": "Help text non resource", "type": "object", "properties": { "value": { "type": "string", "description": "Help Text's value." }, "languageId": { "type": "string", "description": "Help Text's language id.", "format": "uuid" } }, "description": "Provides language-dependent help text." }, "HomeResource": { "title": "Home resource", "type": "object", "properties": { "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" }, "supportedVersions": { "description": "Relation to the list of supported versions", "$ref": "#/components/schemas/Link" }, "records": { "description": "Relation to the collection of all records in the system.", "$ref": "#/components/schemas/Link" }, "classifications": { "description": "Relation to the collection of all classifications in the system.", "$ref": "#/components/schemas/Link" }, "contentTypes": { "description": "Relation to the collection of all content types in the system.", "$ref": "#/components/schemas/Link" }, "collections": { "description": "Relation to the collection of all collections in the system.", "$ref": "#/components/schemas/Link" }, "fieldDefinitions": { "description": "Relation to the collection of all field definitions in the system.", "$ref": "#/components/schemas/Link" }, "fieldGroups": { "description": "Relation to the collection of all field groups in the system.", "$ref": "#/components/schemas/Link" }, "fileTypes": { "description": "Relation to the collection of all file types in the system.", "$ref": "#/components/schemas/Link" }, "userGroups": { "description": "Relation to the collection of all user groups in the system.", "$ref": "#/components/schemas/Link" }, "languages": { "description": "Relation to the collection of all languages in the system.", "$ref": "#/components/schemas/Link" }, "permissions": { "description": "Relation to the collection of all permissions in the system.", "$ref": "#/components/schemas/Link" }, "watermarks": { "description": "Relation to the list of watermarks", "$ref": "#/components/schemas/Link" }, "settings": { "description": "Relation to the list of settings", "$ref": "#/components/schemas/Link" }, "settingDefinitions": { "description": "Relation to the list of setting definitions", "$ref": "#/components/schemas/Link" }, "settingCategories": { "description": "Relation to the list of settings category", "$ref": "#/components/schemas/Link" }, "rules": { "description": "Relation to the collection of all rules in the system.", "$ref": "#/components/schemas/Link" }, "downloadAgreements": { "description": "Relation to the collection of all download agreements in the system.", "$ref": "#/components/schemas/Link" }, "docs": { "description": "Documentation.", "$ref": "#/components/schemas/Link" }, "translations": { "description": "Relation to the collection of all translations in the system.", "$ref": "#/components/schemas/Link" }, "imageOverlays": { "description": "Relation to the collection of all image overlays in the system.", "$ref": "#/components/schemas/Link" }, "fileProcessActions": { "description": "Relation to the collection of all file process actions in the system.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "supportedVersions": { "description": "Relation to the list of supported versions Embed via a \"select-home: supportedVersions\" header.", "$ref": "#/components/schemas/VersionCollectionResource" }, "records": { "description": "Relation to the collection of all records in the system. Embed via a \"select-home: records\" header.", "$ref": "#/components/schemas/RecordPagedCollectionResource" }, "classifications": { "description": "Relation to the collection of all classifications in the system. Embed via a \"select-home: classifications\" header.", "$ref": "#/components/schemas/ClassificationPagedCollectionResource" }, "contentTypes": { "description": "Relation to the collection of all content types in the system. Embed via a \"select-home: contentTypes\" header.", "$ref": "#/components/schemas/ContentTypePagedCollectionResource" }, "collections": { "description": "Relation to the collection of all collections in the system. Embed via a \"select-home: collections\" header.", "$ref": "#/components/schemas/CollectionPagedCollectionResource" }, "fieldDefinitions": { "description": "Relation to the collection of all field definitions in the system. Embed via a \"select-home: fieldDefinitions\" header.", "$ref": "#/components/schemas/FieldDefinitionPagedCollectionResource" }, "fieldGroups": { "description": "Relation to the collection of all field groups in the system. Embed via a \"select-home: fieldGroups\" header.", "$ref": "#/components/schemas/FieldGroupPagedCollectionResource" }, "fileTypes": { "description": "Relation to the collection of all file types in the system. Embed via a \"select-home: fileTypes\" header.", "$ref": "#/components/schemas/FileTypePagedCollectionResource" }, "userGroups": { "description": "Relation to the collection of all user groups in the system. Embed via a \"select-home: userGroups\" header.", "$ref": "#/components/schemas/UserGroupPagedCollectionResource" }, "languages": { "description": "Relation to the collection of all languages in the system. Embed via a \"select-home: languages\" header.", "$ref": "#/components/schemas/LanguagePagedCollectionResource" }, "permissions": { "description": "Relation to the collection of all permissions in the system. Embed via a \"select-home: permissions\" header.", "$ref": "#/components/schemas/PermissionPagedCollectionResource" }, "watermarks": { "description": "Relation to the list of watermarks Embed via a \"select-home: watermarks\" header.", "$ref": "#/components/schemas/WatermarkPagedCollectionResource" }, "settings": { "description": "Relation to the list of settings Embed via a \"select-home: settings\" header.", "$ref": "#/components/schemas/SettingCollectionResource" }, "settingDefinitions": { "description": "Relation to the list of setting definitions Embed via a \"select-home: settingDefinitions\" header.", "$ref": "#/components/schemas/SettingDefinitionPagedCollectionResource" }, "settingCategories": { "description": "Relation to the list of settings category Embed via a \"select-home: settingCategories\" header.", "$ref": "#/components/schemas/SettingCategoryPagedCollectionResource" }, "rules": { "description": "Relation to the collection of all rules in the system. Embed via a \"select-home: rules\" header.", "$ref": "#/components/schemas/RulePagedCollectionResource" }, "downloadAgreements": { "description": "Relation to the collection of all download agreements in the system. Embed via a \"select-home: downloadAgreements\" header.", "$ref": "#/components/schemas/DownloadAgreementPagedCollectionResource" }, "translations": { "description": "Relation to the collection of all translations in the system. Embed via a \"select-home: translations\" header.", "$ref": "#/components/schemas/TranslationPagedCollectionResource" }, "imageOverlays": { "description": "Relation to the collection of all image overlays in the system. Embed via a \"select-home: imageOverlays\" header.", "$ref": "#/components/schemas/ImageOverlayCollectionResource" }, "fileProcessActions": { "description": "Relation to the collection of all file process actions in the system. Embed via a \"select-home: fileProcessActions\" header.", "$ref": "#/components/schemas/FileProcessActionCollectionResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "The API root - provides links to every top-level resource collection (records, classifications, content types, field definitions, users, settings, and more) so a client can discover the whole API by following links from here." }, "HtmlFieldDefinitionCreateCommand": { "title": "Html field definition create command", "type": "object", "properties": { "maximumLength": { "type": "integer", "description": "Maximum number of characters allowed for the field value.", "format": "int32" }, "minimumLength": { "type": "integer", "description": "Minimum number of characters required for the field value.", "format": "int32" }, "regularExpression": { "type": "string", "description": "Regular expression the field value must match." }, "aIEnabled": { "type": "boolean", "description": "When set to true, AI-based content generation is enabled for this field." }, "metadataPredictionEnabled": { "type": "boolean", "description": "When set to true, this field's value can be predicted using AI-based metadata prediction." }, "hints": { "type": "string", "description": "Hints used to guide AI-based metadata prediction for this field." }, "dataType": { "description": "Data type of the field definition. Determines which other properties apply.", "$ref": "#/components/schemas/FieldDefinitionType" }, "enabledLanguages": { "description": "Languages in which this field is enabled. Use AddOrUpdate to add or update members, or Remove to remove them.", "$ref": "#/components/schemas/EditableIdCollectionModel" }, "indexed": { "type": "boolean", "description": "When set to true, the field is indexed for search." }, "inlineStyle": { "type": "string", "description": "Inline CSS style applied to the field in the DAM UI." }, "isReadOnly": { "type": "boolean", "description": "When set to true, the field cannot be edited." }, "isRequired": { "type": "boolean", "description": "When set to true, the field is required." }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelModel" }, "description": "Multi-language labels for the name of this field." }, "languageMode": { "type": "string", "description": "Language mode of the field." }, "memberships": { "description": "Field groups this field is a member of. Use AddOrUpdate to add or update members, or Remove to remove them.", "$ref": "#/components/schemas/EditableIdCollectionModel" }, "name": { "type": "string", "description": "Name of the field." }, "scope": { "type": "string", "description": "Scope of the field." }, "sortIndex": { "type": "integer", "description": "Sort index used to order the field relative to other fields.", "format": "int32" }, "tag": { "type": "string", "description": "Tag associated with the field." }, "defaultValue": { "type": "string", "description": "Default value assigned to the field." }, "resetToDefaultTriggers": { "type": "array", "items": { "type": "string" }, "description": "Names of the triggers that reset the field to its default value." }, "resetToDefaultFields": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Ids of the fields that reset this field to its default value when they change." }, "validation": { "type": "string", "description": "Validation expression applied to the field value." }, "validationErrorMessage": { "type": "string", "description": "Error message shown when validation fails." }, "validationTrigger": { "type": "string", "description": "Trigger that determines when validation is applied." }, "storageMode": { "type": "string", "description": "Storage mode of the field." }, "helpTexts": { "type": "array", "items": { "$ref": "#/components/schemas/HelpTextModel" }, "description": "Multi-language help texts for this field." } }, "description": "Command to create an HTML field definition." }, "HtmlFieldDefinitionResource": { "title": "Html field definition resource", "type": "object", "properties": { "minimumLength": { "type": "integer", "description": "The minimum length for the field.", "format": "int32" }, "maximumLength": { "type": "integer", "description": "The maximum length for the field.", "format": "int32" }, "regularExpression": { "type": "string", "description": "A regular expression for validating the field." }, "aIEnabled": { "type": "boolean", "description": "Indicates whether to allow AI enhancement." }, "metadataPredictionEnabled": { "type": "boolean", "description": "Indicates whether the field can be predicted by the AI." }, "hints": { "type": "string", "description": "AI Prediction hint for this field." }, "label": { "type": "string", "description": "Label of this field." }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelNonResource" }, "description": "A collection of Label items." }, "dataType": { "$ref": "#/components/schemas/FieldDataType" }, "scope": { "enum": [ "RecordContentGlobal", "RecordContentClassDependent", "RecordContentFloating", "ClassificationProfileClassDependent", "UserGlobal", "FileFileTypeDependent", "FileFloating", "IndexerTaskGlobal", "FileGlobal", "ClassificationProfileFloating", "RecordContentContentTypeDependent" ], "type": "string", "description": "Scope." }, "scopeCategory": { "enum": [ "Record", "File", "Classification", "User", "IndexerTask", "MetadataTemplate" ], "type": "string", "description": "Scope category." }, "indexed": { "type": "boolean", "description": "Indicator if searching on this field is enabled." }, "languageMode": { "enum": [ "Single", "Multiple" ], "type": "string", "description": "Language mode of the field." }, "memberships": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Memberships of a field." }, "searchIndexRebuildRequired": { "type": "boolean", "description": "Indicator if a search index rebuild is required." }, "enabledLanguages": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Enabled languages." }, "id": { "type": "string", "description": "Identifier for this field.", "format": "uuid" }, "name": { "type": "string", "description": "Name for this field." }, "isRequired": { "type": "boolean", "description": "Indicates whether this field is required." }, "isReadOnly": { "type": "boolean", "description": "Indicates whether this field is read only." }, "isUniqueIdentifier": { "type": "boolean", "description": "Indicates whether this field is a unique identifier." }, "inlineStyle": { "type": "string", "description": "Inline CSS style applied to this field." }, "sortIndex": { "type": "integer", "description": "Sorting index of this field.", "format": "int32" }, "tag": { "type": "string", "description": "Tag for this field containing extra information. Opt-in: returned only when requested. Include via a \"select-fielddefinition: Tag\" header." }, "createdOn": { "type": "string", "description": "Created on the specified date in UTC time", "format": "date-time" }, "modifiedOn": { "type": "string", "description": "Modified on the specified date in UTC time", "format": "date-time" }, "defaultValue": { "type": "string", "description": "Default value of this field." }, "resetToDefaultTriggers": { "type": "array", "items": { "enum": [ "None", "OnNewField", "OnLoad", "OnSave", "OnAnyFileChange", "OnReclassifyRecord", "OnAnyChange", "OnFieldChange", "OnMasterFileChange", "OnCurrentFileChange", "OnFieldDefinitionChanged", "OnDuplicateRecord", "OnRecordStatusChange" ], "type": "string" }, "description": "'reset to default triggers' value of this field." }, "validation": { "type": "string", "description": "Validation of this field." }, "validationErrorMessage": { "type": "string", "description": "Error message of this field." }, "validationTrigger": { "enum": [ "None", "WhenNeeded", "Always" ], "type": "string", "description": "Trigger that determines when validation is evaluated for this field." }, "storageMode": { "enum": [ "None", "NonEmptyValues", "AllValues", "LogChanges" ], "type": "string", "description": "Storage mode of this field." }, "resetToDefaultFields": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Fields that trigger this field to be reset back to its default value. This is only used if \"ResetToDefaultTriggers\" is set to \"OnFieldChange\"." }, "helpText": { "type": "string", "description": "Help text of this field." }, "helpTexts": { "type": "array", "items": { "$ref": "#/components/schemas/HelpTextNonResource" }, "description": "A collection of HelpText items." }, "_links": { "type": "object", "properties": { "createdBy": { "description": "Relation to the user who created this field definition.", "$ref": "#/components/schemas/Link" }, "modifiedBy": { "description": "Relation to the user who last modified this field definition.", "$ref": "#/components/schemas/Link" }, "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "createdBy": { "description": "Relation to the user who created this field definition. Embed via a \"select-fielddefinition: createdBy\" header.", "$ref": "#/components/schemas/UserResource" }, "modifiedBy": { "description": "Relation to the user who last modified this field definition. Embed via a \"select-fielddefinition: modifiedBy\" header.", "$ref": "#/components/schemas/UserResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "Representation of the definition of an HTML field" }, "HtmlFieldResource": { "title": "Html field resource", "type": "object", "properties": { "dataType": { "$ref": "#/components/schemas/FieldDataType" }, "fieldName": { "type": "string", "description": "Name of this field." }, "label": { "type": "string", "description": "Label of this field." }, "id": { "type": "string", "description": "Id of this field.", "format": "uuid" }, "localizedValues": { "type": "array", "items": { "$ref": "#/components/schemas/HtmlFieldValue" }, "description": "Language specific data of this field." }, "inheritanceState": { "enum": [ "None", "Inherited" ], "type": [ "null", "string" ], "description": "Inheritance State of this field. Opt-in: returned only when requested. Include via a \"select-field: InheritanceState\" header." }, "inheritable": { "type": [ "null", "boolean" ], "description": "Whether the field value can be used as a parent in inheritance hierarchy. Opt-in: returned only when requested. Include via a \"select-field: Inheritable\" header." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" }, "definition": { "description": "Relation to the field definition.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "definition": { "description": "Relation to the field definition. Embed via a \"select-htmlfield: definition\" header.", "$ref": "#/components/schemas/FieldDefinitionResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "Representation of a HtmlField" }, "HtmlFieldValue": { "title": "Html field value", "type": "object", "properties": { "value": { "type": "string", "description": "Html text (must be valid html)." }, "aIInfluenced": { "type": "boolean", "description": "Flag to indicate whether the value has come from AI." }, "languageId": { "type": "string", "description": "The language id.", "format": "uuid" }, "readOnly": { "type": [ "null", "boolean" ], "description": "Tells if the field is read-only." }, "modifiedOn": { "type": "string", "description": "Contains the date/time when the field is last modified.", "format": "date-time" } }, "description": "Language-specific HtmlField value." }, "HyperlinkItemArrayParameterModel": { "title": "Hyperlink item array parameter model", "oneOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/HyperlinkItemModel" } }, { "$ref": "#/components/schemas/HyperlinkItemFieldModel" } ], "description": "Hyperlinks value for a field, provided either as a plain array of hyperlinks or as an add/remove update object." }, "HyperlinkItemFieldModel": { "title": "Hyperlink item field model", "type": "object", "properties": { "addOrUpdate": { "type": "array", "items": { "$ref": "#/components/schemas/HyperlinkItemModel" }, "description": "The hyperlinks to add or update." }, "remove": { "type": "array", "items": { "$ref": "#/components/schemas/HyperlinkItemModel" }, "description": "The hyperlinks to remove." } }, "description": "Add/remove update for a hyperlinks field value." }, "HyperlinkItemModel": { "title": "Hyperlink item model", "type": "object", "properties": { "url": { "type": "string", "description": "The hyperlink URL." }, "displayText": { "type": "string", "description": "The display text shown for the hyperlink." } }, "description": "A single hyperlink entry for a hyperlinks field." }, "HyperlinkListFieldDefinitionCreateCommand": { "title": "Hyperlink list field definition create command", "type": "object", "properties": { "dataType": { "description": "Data type of the field definition. Determines which other properties apply.", "$ref": "#/components/schemas/FieldDefinitionType" }, "enabledLanguages": { "description": "Languages in which this field is enabled. Use AddOrUpdate to add or update members, or Remove to remove them.", "$ref": "#/components/schemas/EditableIdCollectionModel" }, "indexed": { "type": "boolean", "description": "When set to true, the field is indexed for search." }, "inlineStyle": { "type": "string", "description": "Inline CSS style applied to the field in the DAM UI." }, "isReadOnly": { "type": "boolean", "description": "When set to true, the field cannot be edited." }, "isRequired": { "type": "boolean", "description": "When set to true, the field is required." }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelModel" }, "description": "Multi-language labels for the name of this field." }, "languageMode": { "type": "string", "description": "Language mode of the field." }, "memberships": { "description": "Field groups this field is a member of. Use AddOrUpdate to add or update members, or Remove to remove them.", "$ref": "#/components/schemas/EditableIdCollectionModel" }, "name": { "type": "string", "description": "Name of the field." }, "scope": { "type": "string", "description": "Scope of the field." }, "sortIndex": { "type": "integer", "description": "Sort index used to order the field relative to other fields.", "format": "int32" }, "tag": { "type": "string", "description": "Tag associated with the field." }, "defaultValue": { "type": "string", "description": "Default value assigned to the field." }, "resetToDefaultTriggers": { "type": "array", "items": { "type": "string" }, "description": "Names of the triggers that reset the field to its default value." }, "resetToDefaultFields": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Ids of the fields that reset this field to its default value when they change." }, "validation": { "type": "string", "description": "Validation expression applied to the field value." }, "validationErrorMessage": { "type": "string", "description": "Error message shown when validation fails." }, "validationTrigger": { "type": "string", "description": "Trigger that determines when validation is applied." }, "storageMode": { "type": "string", "description": "Storage mode of the field." }, "helpTexts": { "type": "array", "items": { "$ref": "#/components/schemas/HelpTextModel" }, "description": "Multi-language help texts for this field." } }, "description": "Command to create a hyperlink list field definition." }, "HyperlinkListFieldDefinitionResource": { "title": "Hyperlink list field definition resource", "type": "object", "properties": { "label": { "type": "string", "description": "Label of this field." }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelNonResource" }, "description": "A collection of Label items." }, "dataType": { "$ref": "#/components/schemas/FieldDataType" }, "scope": { "enum": [ "RecordContentGlobal", "RecordContentClassDependent", "RecordContentFloating", "ClassificationProfileClassDependent", "UserGlobal", "FileFileTypeDependent", "FileFloating", "IndexerTaskGlobal", "FileGlobal", "ClassificationProfileFloating", "RecordContentContentTypeDependent" ], "type": "string", "description": "Scope." }, "scopeCategory": { "enum": [ "Record", "File", "Classification", "User", "IndexerTask", "MetadataTemplate" ], "type": "string", "description": "Scope category." }, "indexed": { "type": "boolean", "description": "Indicator if searching on this field is enabled." }, "languageMode": { "enum": [ "Single", "Multiple" ], "type": "string", "description": "Language mode of the field." }, "memberships": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Memberships of a field." }, "searchIndexRebuildRequired": { "type": "boolean", "description": "Indicator if a search index rebuild is required." }, "enabledLanguages": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Enabled languages." }, "id": { "type": "string", "description": "Identifier for this field.", "format": "uuid" }, "name": { "type": "string", "description": "Name for this field." }, "isRequired": { "type": "boolean", "description": "Indicates whether this field is required." }, "isReadOnly": { "type": "boolean", "description": "Indicates whether this field is read only." }, "isUniqueIdentifier": { "type": "boolean", "description": "Indicates whether this field is a unique identifier." }, "inlineStyle": { "type": "string", "description": "Inline CSS style applied to this field." }, "sortIndex": { "type": "integer", "description": "Sorting index of this field.", "format": "int32" }, "tag": { "type": "string", "description": "Tag for this field containing extra information. Opt-in: returned only when requested. Include via a \"select-fielddefinition: Tag\" header." }, "createdOn": { "type": "string", "description": "Created on the specified date in UTC time", "format": "date-time" }, "modifiedOn": { "type": "string", "description": "Modified on the specified date in UTC time", "format": "date-time" }, "defaultValue": { "type": "string", "description": "Default value of this field." }, "resetToDefaultTriggers": { "type": "array", "items": { "enum": [ "None", "OnNewField", "OnLoad", "OnSave", "OnAnyFileChange", "OnReclassifyRecord", "OnAnyChange", "OnFieldChange", "OnMasterFileChange", "OnCurrentFileChange", "OnFieldDefinitionChanged", "OnDuplicateRecord", "OnRecordStatusChange" ], "type": "string" }, "description": "'reset to default triggers' value of this field." }, "validation": { "type": "string", "description": "Validation of this field." }, "validationErrorMessage": { "type": "string", "description": "Error message of this field." }, "validationTrigger": { "enum": [ "None", "WhenNeeded", "Always" ], "type": "string", "description": "Trigger that determines when validation is evaluated for this field." }, "storageMode": { "enum": [ "None", "NonEmptyValues", "AllValues", "LogChanges" ], "type": "string", "description": "Storage mode of this field." }, "resetToDefaultFields": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Fields that trigger this field to be reset back to its default value. This is only used if \"ResetToDefaultTriggers\" is set to \"OnFieldChange\"." }, "helpText": { "type": "string", "description": "Help text of this field." }, "helpTexts": { "type": "array", "items": { "$ref": "#/components/schemas/HelpTextNonResource" }, "description": "A collection of HelpText items." }, "_links": { "type": "object", "properties": { "createdBy": { "description": "Relation to the user who created this field definition.", "$ref": "#/components/schemas/Link" }, "modifiedBy": { "description": "Relation to the user who last modified this field definition.", "$ref": "#/components/schemas/Link" }, "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "createdBy": { "description": "Relation to the user who created this field definition. Embed via a \"select-fielddefinition: createdBy\" header.", "$ref": "#/components/schemas/UserResource" }, "modifiedBy": { "description": "Relation to the user who last modified this field definition. Embed via a \"select-fielddefinition: modifiedBy\" header.", "$ref": "#/components/schemas/UserResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "Representation of the definition of a hyperlink list field" }, "HyperlinkListFieldResource": { "title": "Hyperlink list field resource", "type": "object", "properties": { "dataType": { "$ref": "#/components/schemas/FieldDataType" }, "fieldName": { "type": "string", "description": "Name of this field." }, "label": { "type": "string", "description": "Label of this field." }, "id": { "type": "string", "description": "Id of this field.", "format": "uuid" }, "localizedValues": { "type": "array", "items": { "$ref": "#/components/schemas/HyperlinkListFieldValues" }, "description": "Language specific data of this field." }, "inheritanceState": { "enum": [ "None", "Inherited" ], "type": [ "null", "string" ], "description": "Inheritance State of this field. Opt-in: returned only when requested. Include via a \"select-field: InheritanceState\" header." }, "inheritable": { "type": [ "null", "boolean" ], "description": "Whether the field value can be used as a parent in inheritance hierarchy. Opt-in: returned only when requested. Include via a \"select-field: Inheritable\" header." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" }, "definition": { "description": "Relation to the field definition.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "definition": { "description": "Relation to the field definition. Embed via a \"select-hyperlinklistfield: definition\" header.", "$ref": "#/components/schemas/FieldDefinitionResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "Representation of an hyperlink list field." }, "HyperlinkListFieldValues": { "title": "Hyperlink list field values", "type": "object", "properties": { "hyperlinks": { "type": "array", "items": { "$ref": "#/components/schemas/HyperlinkResource" }, "description": "Language-specific collection of texts." }, "languageId": { "type": "string", "description": "The language id.", "format": "uuid" }, "readOnly": { "type": [ "null", "boolean" ], "description": "Tells if the field is read-only." }, "modifiedOn": { "type": "string", "description": "Contains the date/time when the field is last modified.", "format": "date-time" } }, "description": "The collection of language-specific values stored in the HyperlinkList field." }, "HyperlinkResource": { "title": "Hyperlink resource", "type": "object", "properties": { "url": { "type": "string", "description": "The URL of the hyperlink." }, "displayText": { "type": "string", "description": "The display text of the hyperlink" } }, "description": "Hyperlink item." }, "ImageNonResource": { "title": "Image non resource", "type": "object", "properties": { "size": { "type": "integer", "description": "Number of bytes of this image or 0 if not image is assigned.", "format": "int64" }, "width": { "type": "integer", "description": "Width in pixels of the image assigned or -1 if no image is assigned.", "format": "int32" }, "height": { "type": "integer", "description": "Height in pixels of the image assigned or -1 if no image is assigned.", "format": "int32" }, "extension": { "type": "string", "description": "Returns the file extension suited for an image of this type or an empty String if no image is assigned." }, "uri": { "type": [ "null", "string" ], "description": "Returns a path to image or if no image is assigned. This URL remains valid for twenty-four hours." } }, "description": "Dimensions and access details for an image assigned to a field or record." }, "ImageOverlayClassificationCollectionResource": { "title": "Image overlay classification collection resource", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ImageOverlayClassificationResource" }, "description": "A collection of resource items." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of a non-paged collection of image overlay classifications" }, "ImageOverlayClassificationResource": { "title": "Image overlay classification resource", "type": "object", "properties": { "id": { "type": "string", "description": "Id of this classification.", "format": "uuid" }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" }, "target": { "description": "Relation to the target classification.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "target": { "description": "Relation to the target classification. Embed via a \"select-imageoverlayclassification: target\" header.", "$ref": "#/components/schemas/ClassificationResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "Representation of overlay's classification" }, "ImageOverlayCollectionResource": { "title": "Image overlay collection resource", "type": "object", "properties": { "pageNumber": { "type": [ "null", "integer" ], "description": "The current page of this paged collection.", "format": "int32" }, "pageSize": { "type": [ "null", "integer" ], "description": "The current page size of this paged collection.", "format": "int32" }, "skip": { "type": [ "null", "integer" ], "description": "The current skip size of this paged collection.", "format": "int32" }, "take": { "type": [ "null", "integer" ], "description": "The current take size of this paged collection.", "format": "int32" }, "totalCount": { "type": "integer", "description": "The total count of items in this paged collection, not just on the current page.", "format": "int64" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ImageOverlayResource" }, "description": "One page of this paged collection, which is a subcollection of the complete collection." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" }, "first": { "description": "A link to the first page of this paged collection.", "$ref": "#/components/schemas/Link" }, "prev": { "description": "A link to the previous page of this paged collection.", "$ref": "#/components/schemas/Link" }, "next": { "description": "A link to the next page of this paged collection.", "$ref": "#/components/schemas/Link" }, "last": { "description": "A link to the last page of this paged collection.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of a paged collection of image overlays" }, "ImageOverlayCreateCommand": { "title": "Image overlay create command", "type": "object", "properties": { "name": { "type": "string", "description": "The name of the image overlay." }, "enabled": { "type": "boolean", "description": "Whether the image overlay is enabled." }, "userGroups": { "description": "The user groups this overlay applies to. Use AddOrUpdate to add or update, or Remove to remove.", "$ref": "#/components/schemas/EditableIdCollectionModel" }, "classifications": { "description": "The classifications this overlay applies to. Use AddOrUpdate to add or update, or Remove to remove.", "$ref": "#/components/schemas/EditableIdCollectionModel" } }, "description": "Command to create a new image overlay." }, "ImageOverlayResource": { "title": "Image overlay resource", "type": "object", "properties": { "id": { "type": "integer", "description": "The Id of this image overlay.", "format": "int32" }, "name": { "type": "string", "description": "The name of this image overlay." }, "enabled": { "type": "boolean", "description": "Whether this image overlay is enabled." }, "createdOn": { "type": "string", "description": "The date when this image overlay was created", "format": "date-time" }, "modifiedOn": { "type": "string", "description": "The date when this image overlay was updated", "format": "date-time" }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" }, "userGroups": { "description": "Relation to the user groups of this image overlay.", "$ref": "#/components/schemas/Link" }, "classifications": { "description": "Relation to a collection of image overlay classifications.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "userGroups": { "description": "Relation to the user groups of this image overlay. Embed via a \"select-imageoverlay: userGroups\" header.", "$ref": "#/components/schemas/ImageOverlayUserGroupCollectionResource" }, "classifications": { "description": "Relation to a collection of image overlay classifications. Embed via a \"select-imageoverlay: classifications\" header.", "$ref": "#/components/schemas/ImageOverlayClassificationCollectionResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "A configurable graphic that a rule action can apply on top of an image rendition - e.g. to visually flag its status - shown only to the user groups it's scoped to." }, "ImageOverlayUserGroupCollectionResource": { "title": "Image overlay user group collection resource", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ImageOverlayUserGroupResource" }, "description": "A collection of resource items." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Collection of applicable Image overlay's user groups" }, "ImageOverlayUserGroupResource": { "title": "Image overlay user group resource", "type": "object", "properties": { "id": { "type": "string", "description": "Id of this user group.", "format": "uuid" }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" }, "target": { "description": "Relation to the target user group.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "target": { "description": "Relation to the target user group. Embed via a \"select-imageoverlayusergroup: target\" header.", "$ref": "#/components/schemas/UserGroupResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "Representation of Eula's user group" }, "ImageResource": { "title": "Image resource", "type": "object", "properties": { "size": { "type": "integer", "description": "Number of bytes of this image or 0 if not image is assigned.", "format": "int64" }, "width": { "type": "integer", "description": "Width in pixels of the image assigned or -1 if no image is assigned.", "format": "int32" }, "height": { "type": "integer", "description": "Height in pixels of the image assigned or -1 if no image is assigned.", "format": "int32" }, "extension": { "type": "string", "description": "Returns the file extension suited for an image of this type or an empty String if no image is assigned." }, "uri": { "type": [ "null", "string" ], "description": "Returns a path to image or if no image is assigned. This URL remains valid for twenty-four hours." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of an Image" }, "ImageSearchCommand": { "title": "Image search command", "type": "object", "properties": { "maxResults": { "type": "integer", "description": "The maximum number of results to return.", "format": "int32" }, "url": { "type": "string", "description": "The URL of the image to search for." }, "userAgent": { "type": "string", "description": "The user agent to use when fetching the image at Url." }, "sift": { "type": "string", "description": "SIFT matching options for the search." }, "pHash": { "type": "string", "description": "Perceptual hash matching options for the search." }, "creatorEmail": { "type": "string", "description": "Email address of the user the job is created on behalf of." }, "disableNotification": { "type": "boolean", "description": "When set to true, suppresses notifications for this job." }, "earliestStartDate": { "type": [ "null", "string" ], "description": "Earliest date and time at which the job is allowed to start executing.", "format": "date-time" }, "priority": { "enum": [ "High", "Medium" ], "type": "string", "description": "Priority used to schedule this job relative to other maintenance jobs." }, "type": { "enum": [ "Classification", "Record", "ExportAuditTrail", "BulkRecord", "AcceptDownloadOrderAgreement", "BulkCollection", "ExportContentItemsList" ], "type": "string", "description": "Type of maintenance job to create." }, "targets": { "type": "array", "items": { "type": "string" }, "description": "Targets the job's actions are applied to." }, "actions": { "type": "array", "items": { "$ref": "#/components/schemas/ActionModel" }, "description": "Actions to execute for each target of this job." }, "title": { "type": "string", "description": "Title of the job. For a download or contact-sheet order this is shown on the Downloads page in Content Workspace; if omitted, it defaults to the file name, or \"X items\" when multiple files were ordered. Either plain text, or a JSON string of the form {\"studioName\":\"...\",\"moduleName\":\"...\",\"translationKey\":\"...\"} to look up a translated value for non-English users (see the Localization > Translations section of the DAM Administrator Guide for how translations are registered)." }, "description": { "type": "string", "description": "Description of the job. For a download or contact-sheet order this is shown on the Downloads page in Content Workspace; if omitted, it defaults to \"Download\". Accepts the same plain-text-or-translation-key JSON format as Title." }, "errorMode": { "type": "string", "description": "Determines how the job behaves when one of its targets fails to execute." } }, "description": "Command to search for images similar to an image at a given URL." }, "IndexRebuildTargetResource": { "title": "Index rebuild target resource", "enum": [ "Classification", "Record" ], "type": "string", "x-enum-descriptions": [ "Rebuild the index for classifications.", "Rebuild the index for records." ] }, "InfoResource": { "title": "Info resource", "type": "object", "properties": { "releaseInfo": { "description": "The currently active DAM release.", "$ref": "#/components/schemas/ReleaseResource" }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Version information about the currently active DAM release." }, "JsonFieldDefinitionCreateCommand": { "title": "Json field definition create command", "type": "object", "properties": { "dataType": { "description": "Data type of the field definition. Determines which other properties apply.", "$ref": "#/components/schemas/FieldDefinitionType" }, "enabledLanguages": { "description": "Languages in which this field is enabled. Use AddOrUpdate to add or update members, or Remove to remove them.", "$ref": "#/components/schemas/EditableIdCollectionModel" }, "indexed": { "type": "boolean", "description": "When set to true, the field is indexed for search." }, "inlineStyle": { "type": "string", "description": "Inline CSS style applied to the field in the DAM UI." }, "isReadOnly": { "type": "boolean", "description": "When set to true, the field cannot be edited." }, "isRequired": { "type": "boolean", "description": "When set to true, the field is required." }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelModel" }, "description": "Multi-language labels for the name of this field." }, "languageMode": { "type": "string", "description": "Language mode of the field." }, "memberships": { "description": "Field groups this field is a member of. Use AddOrUpdate to add or update members, or Remove to remove them.", "$ref": "#/components/schemas/EditableIdCollectionModel" }, "name": { "type": "string", "description": "Name of the field." }, "scope": { "type": "string", "description": "Scope of the field." }, "sortIndex": { "type": "integer", "description": "Sort index used to order the field relative to other fields.", "format": "int32" }, "tag": { "type": "string", "description": "Tag associated with the field." }, "defaultValue": { "type": "string", "description": "Default value assigned to the field." }, "resetToDefaultTriggers": { "type": "array", "items": { "type": "string" }, "description": "Names of the triggers that reset the field to its default value." }, "resetToDefaultFields": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Ids of the fields that reset this field to its default value when they change." }, "validation": { "type": "string", "description": "Validation expression applied to the field value." }, "validationErrorMessage": { "type": "string", "description": "Error message shown when validation fails." }, "validationTrigger": { "type": "string", "description": "Trigger that determines when validation is applied." }, "storageMode": { "type": "string", "description": "Storage mode of the field." }, "helpTexts": { "type": "array", "items": { "$ref": "#/components/schemas/HelpTextModel" }, "description": "Multi-language help texts for this field." } }, "description": "Command to create a JSON field definition." }, "JsonFieldDefinitionResource": { "title": "Json field definition resource", "type": "object", "properties": { "label": { "type": "string", "description": "Label of this field." }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelNonResource" }, "description": "A collection of Label items." }, "dataType": { "$ref": "#/components/schemas/FieldDataType" }, "scope": { "enum": [ "RecordContentGlobal", "RecordContentClassDependent", "RecordContentFloating", "ClassificationProfileClassDependent", "UserGlobal", "FileFileTypeDependent", "FileFloating", "IndexerTaskGlobal", "FileGlobal", "ClassificationProfileFloating", "RecordContentContentTypeDependent" ], "type": "string", "description": "Scope." }, "scopeCategory": { "enum": [ "Record", "File", "Classification", "User", "IndexerTask", "MetadataTemplate" ], "type": "string", "description": "Scope category." }, "indexed": { "type": "boolean", "description": "Indicator if searching on this field is enabled." }, "languageMode": { "enum": [ "Single", "Multiple" ], "type": "string", "description": "Language mode of the field." }, "memberships": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Memberships of a field." }, "searchIndexRebuildRequired": { "type": "boolean", "description": "Indicator if a search index rebuild is required." }, "enabledLanguages": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Enabled languages." }, "id": { "type": "string", "description": "Identifier for this field.", "format": "uuid" }, "name": { "type": "string", "description": "Name for this field." }, "isRequired": { "type": "boolean", "description": "Indicates whether this field is required." }, "isReadOnly": { "type": "boolean", "description": "Indicates whether this field is read only." }, "isUniqueIdentifier": { "type": "boolean", "description": "Indicates whether this field is a unique identifier." }, "inlineStyle": { "type": "string", "description": "Inline CSS style applied to this field." }, "sortIndex": { "type": "integer", "description": "Sorting index of this field.", "format": "int32" }, "tag": { "type": "string", "description": "Tag for this field containing extra information. Opt-in: returned only when requested. Include via a \"select-fielddefinition: Tag\" header." }, "createdOn": { "type": "string", "description": "Created on the specified date in UTC time", "format": "date-time" }, "modifiedOn": { "type": "string", "description": "Modified on the specified date in UTC time", "format": "date-time" }, "defaultValue": { "type": "string", "description": "Default value of this field." }, "resetToDefaultTriggers": { "type": "array", "items": { "enum": [ "None", "OnNewField", "OnLoad", "OnSave", "OnAnyFileChange", "OnReclassifyRecord", "OnAnyChange", "OnFieldChange", "OnMasterFileChange", "OnCurrentFileChange", "OnFieldDefinitionChanged", "OnDuplicateRecord", "OnRecordStatusChange" ], "type": "string" }, "description": "'reset to default triggers' value of this field." }, "validation": { "type": "string", "description": "Validation of this field." }, "validationErrorMessage": { "type": "string", "description": "Error message of this field." }, "validationTrigger": { "enum": [ "None", "WhenNeeded", "Always" ], "type": "string", "description": "Trigger that determines when validation is evaluated for this field." }, "storageMode": { "enum": [ "None", "NonEmptyValues", "AllValues", "LogChanges" ], "type": "string", "description": "Storage mode of this field." }, "resetToDefaultFields": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Fields that trigger this field to be reset back to its default value. This is only used if \"ResetToDefaultTriggers\" is set to \"OnFieldChange\"." }, "helpText": { "type": "string", "description": "Help text of this field." }, "helpTexts": { "type": "array", "items": { "$ref": "#/components/schemas/HelpTextNonResource" }, "description": "A collection of HelpText items." }, "_links": { "type": "object", "properties": { "createdBy": { "description": "Relation to the user who created this field definition.", "$ref": "#/components/schemas/Link" }, "modifiedBy": { "description": "Relation to the user who last modified this field definition.", "$ref": "#/components/schemas/Link" }, "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "createdBy": { "description": "Relation to the user who created this field definition. Embed via a \"select-fielddefinition: createdBy\" header.", "$ref": "#/components/schemas/UserResource" }, "modifiedBy": { "description": "Relation to the user who last modified this field definition. Embed via a \"select-fielddefinition: modifiedBy\" header.", "$ref": "#/components/schemas/UserResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "Representation of the definition of a JSON field" }, "JsonFieldResource": { "title": "Json field resource", "type": "object", "properties": { "dataType": { "$ref": "#/components/schemas/FieldDataType" }, "fieldName": { "type": "string", "description": "Name of this field." }, "label": { "type": "string", "description": "Label of this field." }, "id": { "type": "string", "description": "Id of this field.", "format": "uuid" }, "localizedValues": { "type": "array", "items": { "$ref": "#/components/schemas/JsonFieldValue" }, "description": "Language specific data of this field." }, "inheritanceState": { "enum": [ "None", "Inherited" ], "type": [ "null", "string" ], "description": "Inheritance State of this field. Opt-in: returned only when requested. Include via a \"select-field: InheritanceState\" header." }, "inheritable": { "type": [ "null", "boolean" ], "description": "Whether the field value can be used as a parent in inheritance hierarchy. Opt-in: returned only when requested. Include via a \"select-field: Inheritable\" header." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" }, "definition": { "description": "Relation to the field definition.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "definition": { "description": "Relation to the field definition. Embed via a \"select-jsonfield: definition\" header.", "$ref": "#/components/schemas/FieldDefinitionResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "Representation of a text field whose value holds JSON content." }, "JsonFieldValue": { "title": "Json field value", "type": "object", "properties": { "value": { "type": "string", "description": "JSON text (must be valid JSON)." }, "languageId": { "type": "string", "description": "The language id.", "format": "uuid" }, "readOnly": { "type": [ "null", "boolean" ], "description": "Tells if the field is read-only." }, "modifiedOn": { "type": "string", "description": "Contains the date/time when the field is last modified.", "format": "date-time" } }, "description": "Language-specific JsonField value." }, "LabelModel": { "title": "Label model", "type": "object", "properties": { "value": { "type": "string", "description": "Label value." }, "languageId": { "type": "string", "description": "Identifier of the language this label is in.", "format": "uuid" } }, "description": "Label value for a single language." }, "LabelNonResource": { "title": "Label non resource", "type": "object", "properties": { "value": { "type": "string", "description": "Label's value." }, "languageId": { "type": "string", "description": "Label's language id.", "format": "uuid" } }, "description": "Provides language-dependent label for the classification." }, "LabelPathNonResource": { "title": "Label path non resource", "type": "object", "properties": { "value": { "type": "string", "description": "Label path value." }, "languageId": { "type": "string", "description": "Label path language id.", "format": "uuid" } }, "description": "Provides language-dependent label path for the classification." }, "LanguageCreateCommand": { "title": "Language create command", "type": "object", "properties": { "name": { "type": "string", "description": "The name of the language." }, "culture": { "type": "string", "description": "The culture code of the language (e.g. \"en-US\")." }, "enabledForFields": { "type": "boolean", "description": "Whether this language is enabled for field values." }, "enabledForUI": { "type": "boolean", "description": "Whether this language is enabled for the user interface." }, "tag": { "type": "string", "description": "The tag of the language." } }, "description": "Command to create a new language." }, "LanguageEditCommand": { "title": "Language edit command", "type": "object", "properties": { "name": { "type": "string", "description": "The name of the language." }, "culture": { "type": "string", "description": "The culture code of the language (e.g. \"en-US\")." }, "enabledForFields": { "type": "boolean", "description": "Whether this language is enabled for field values." }, "enabledForUI": { "type": "boolean", "description": "Whether this language is enabled for the user interface." }, "tag": { "type": "string", "description": "The tag of the language." } }, "description": "Command to edit an existing language." }, "LanguageListFieldDefinitionCreateCommand": { "title": "Language list field definition create command", "type": "object", "properties": { "dataType": { "description": "Data type of the field definition. Determines which other properties apply.", "$ref": "#/components/schemas/FieldDefinitionType" }, "enabledLanguages": { "description": "Languages in which this field is enabled. Use AddOrUpdate to add or update members, or Remove to remove them.", "$ref": "#/components/schemas/EditableIdCollectionModel" }, "indexed": { "type": "boolean", "description": "When set to true, the field is indexed for search." }, "inlineStyle": { "type": "string", "description": "Inline CSS style applied to the field in the DAM UI." }, "isReadOnly": { "type": "boolean", "description": "When set to true, the field cannot be edited." }, "isRequired": { "type": "boolean", "description": "When set to true, the field is required." }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelModel" }, "description": "Multi-language labels for the name of this field." }, "languageMode": { "type": "string", "description": "Language mode of the field." }, "memberships": { "description": "Field groups this field is a member of. Use AddOrUpdate to add or update members, or Remove to remove them.", "$ref": "#/components/schemas/EditableIdCollectionModel" }, "name": { "type": "string", "description": "Name of the field." }, "scope": { "type": "string", "description": "Scope of the field." }, "sortIndex": { "type": "integer", "description": "Sort index used to order the field relative to other fields.", "format": "int32" }, "tag": { "type": "string", "description": "Tag associated with the field." }, "defaultValue": { "type": "string", "description": "Default value assigned to the field." }, "resetToDefaultTriggers": { "type": "array", "items": { "type": "string" }, "description": "Names of the triggers that reset the field to its default value." }, "resetToDefaultFields": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Ids of the fields that reset this field to its default value when they change." }, "validation": { "type": "string", "description": "Validation expression applied to the field value." }, "validationErrorMessage": { "type": "string", "description": "Error message shown when validation fails." }, "validationTrigger": { "type": "string", "description": "Trigger that determines when validation is applied." }, "storageMode": { "type": "string", "description": "Storage mode of the field." }, "helpTexts": { "type": "array", "items": { "$ref": "#/components/schemas/HelpTextModel" }, "description": "Multi-language help texts for this field." } }, "description": "Command to create a language list field definition." }, "LanguageListFieldDefinitionResource": { "title": "Language list field definition resource", "type": "object", "properties": { "label": { "type": "string", "description": "Label of this field." }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelNonResource" }, "description": "A collection of Label items." }, "dataType": { "$ref": "#/components/schemas/FieldDataType" }, "scope": { "enum": [ "RecordContentGlobal", "RecordContentClassDependent", "RecordContentFloating", "ClassificationProfileClassDependent", "UserGlobal", "FileFileTypeDependent", "FileFloating", "IndexerTaskGlobal", "FileGlobal", "ClassificationProfileFloating", "RecordContentContentTypeDependent" ], "type": "string", "description": "Scope." }, "scopeCategory": { "enum": [ "Record", "File", "Classification", "User", "IndexerTask", "MetadataTemplate" ], "type": "string", "description": "Scope category." }, "indexed": { "type": "boolean", "description": "Indicator if searching on this field is enabled." }, "languageMode": { "enum": [ "Single", "Multiple" ], "type": "string", "description": "Language mode of the field." }, "memberships": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Memberships of a field." }, "searchIndexRebuildRequired": { "type": "boolean", "description": "Indicator if a search index rebuild is required." }, "enabledLanguages": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Enabled languages." }, "id": { "type": "string", "description": "Identifier for this field.", "format": "uuid" }, "name": { "type": "string", "description": "Name for this field." }, "isRequired": { "type": "boolean", "description": "Indicates whether this field is required." }, "isReadOnly": { "type": "boolean", "description": "Indicates whether this field is read only." }, "isUniqueIdentifier": { "type": "boolean", "description": "Indicates whether this field is a unique identifier." }, "inlineStyle": { "type": "string", "description": "Inline CSS style applied to this field." }, "sortIndex": { "type": "integer", "description": "Sorting index of this field.", "format": "int32" }, "tag": { "type": "string", "description": "Tag for this field containing extra information. Opt-in: returned only when requested. Include via a \"select-fielddefinition: Tag\" header." }, "createdOn": { "type": "string", "description": "Created on the specified date in UTC time", "format": "date-time" }, "modifiedOn": { "type": "string", "description": "Modified on the specified date in UTC time", "format": "date-time" }, "defaultValue": { "type": "string", "description": "Default value of this field." }, "resetToDefaultTriggers": { "type": "array", "items": { "enum": [ "None", "OnNewField", "OnLoad", "OnSave", "OnAnyFileChange", "OnReclassifyRecord", "OnAnyChange", "OnFieldChange", "OnMasterFileChange", "OnCurrentFileChange", "OnFieldDefinitionChanged", "OnDuplicateRecord", "OnRecordStatusChange" ], "type": "string" }, "description": "'reset to default triggers' value of this field." }, "validation": { "type": "string", "description": "Validation of this field." }, "validationErrorMessage": { "type": "string", "description": "Error message of this field." }, "validationTrigger": { "enum": [ "None", "WhenNeeded", "Always" ], "type": "string", "description": "Trigger that determines when validation is evaluated for this field." }, "storageMode": { "enum": [ "None", "NonEmptyValues", "AllValues", "LogChanges" ], "type": "string", "description": "Storage mode of this field." }, "resetToDefaultFields": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Fields that trigger this field to be reset back to its default value. This is only used if \"ResetToDefaultTriggers\" is set to \"OnFieldChange\"." }, "helpText": { "type": "string", "description": "Help text of this field." }, "helpTexts": { "type": "array", "items": { "$ref": "#/components/schemas/HelpTextNonResource" }, "description": "A collection of HelpText items." }, "_links": { "type": "object", "properties": { "createdBy": { "description": "Relation to the user who created this field definition.", "$ref": "#/components/schemas/Link" }, "modifiedBy": { "description": "Relation to the user who last modified this field definition.", "$ref": "#/components/schemas/Link" }, "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "createdBy": { "description": "Relation to the user who created this field definition. Embed via a \"select-fielddefinition: createdBy\" header.", "$ref": "#/components/schemas/UserResource" }, "modifiedBy": { "description": "Relation to the user who last modified this field definition. Embed via a \"select-fielddefinition: modifiedBy\" header.", "$ref": "#/components/schemas/UserResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "Representation of the definition of a language list field" }, "LanguageListFieldResource": { "title": "Language list field resource", "type": "object", "properties": { "dataType": { "$ref": "#/components/schemas/FieldDataType" }, "fieldName": { "type": "string", "description": "Name of this field." }, "label": { "type": "string", "description": "Label of this field." }, "id": { "type": "string", "description": "Id of this field.", "format": "uuid" }, "localizedValues": { "type": "array", "items": { "$ref": "#/components/schemas/LanguageListFieldValues" }, "description": "Language specific data of this field." }, "inheritanceState": { "enum": [ "None", "Inherited" ], "type": [ "null", "string" ], "description": "Inheritance State of this field. Opt-in: returned only when requested. Include via a \"select-field: InheritanceState\" header." }, "inheritable": { "type": [ "null", "boolean" ], "description": "Whether the field value can be used as a parent in inheritance hierarchy. Opt-in: returned only when requested. Include via a \"select-field: Inheritable\" header." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" }, "definition": { "description": "Relation to the field definition.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "definition": { "description": "Relation to the field definition. Embed via a \"select-languagelistfield: definition\" header.", "$ref": "#/components/schemas/FieldDefinitionResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "Representation of a LanguageListField" }, "LanguageListFieldValues": { "title": "Language list field values", "type": "object", "properties": { "values": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Language-specific collection of language Ids (represented as GUID values)." }, "languageId": { "type": "string", "description": "The language id.", "format": "uuid" }, "readOnly": { "type": [ "null", "boolean" ], "description": "Tells if the field is read-only." }, "modifiedOn": { "type": "string", "description": "Contains the date/time when the field is last modified.", "format": "date-time" } }, "description": "The collection of language-specific values stored in the LanguageList field." }, "LanguagePagedCollectionResource": { "title": "Language paged collection resource", "type": "object", "properties": { "pageNumber": { "type": [ "null", "integer" ], "description": "The current page of this paged collection.", "format": "int32" }, "pageSize": { "type": [ "null", "integer" ], "description": "The current page size of this paged collection.", "format": "int32" }, "skip": { "type": [ "null", "integer" ], "description": "The current skip size of this paged collection.", "format": "int32" }, "take": { "type": [ "null", "integer" ], "description": "The current take size of this paged collection.", "format": "int32" }, "totalCount": { "type": "integer", "description": "The total count of items in this paged collection, not just on the current page.", "format": "int64" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/LanguageResource" }, "description": "One page of this paged collection, which is a subcollection of the complete collection." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" }, "first": { "description": "A link to the first page of this paged collection.", "$ref": "#/components/schemas/Link" }, "prev": { "description": "A link to the previous page of this paged collection.", "$ref": "#/components/schemas/Link" }, "next": { "description": "A link to the next page of this paged collection.", "$ref": "#/components/schemas/Link" }, "last": { "description": "A link to the last page of this paged collection.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of a paged collection of languages" }, "LanguageResource": { "title": "Language resource", "type": "object", "properties": { "id": { "type": "string", "description": "Language identifier.", "format": "uuid" }, "isEnabledForFields": { "type": "boolean", "description": "Value indicating whether this language is enabled for fields." }, "isEnabledForUI": { "type": "boolean", "description": "Value indicating whether this language is enabled for UI." }, "name": { "type": "string", "description": "Name of this language." }, "culture": { "type": "string", "description": "Culture of this language." }, "createdOn": { "type": "string", "description": "Created on date in UTC of this language.", "format": "date-time" }, "modifiedOn": { "type": "string", "description": "Modified on date in UTC of this language.", "format": "date-time" }, "tag": { "type": "string", "description": "Tag of this object. The value of this property has to be valid Xml. Opt-in: returned only when requested. Include via a \"select-language: Tag\" header." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" }, "image": { "description": "Relation to a language image.", "$ref": "#/components/schemas/Link" }, "createdBy": { "description": "Relation to the user who created this language.", "$ref": "#/components/schemas/Link" }, "modifiedBy": { "description": "Relation to the user who last modified this language.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "image": { "description": "Relation to a language image. Embed via a \"select-language: image\" header.", "$ref": "#/components/schemas/ImageResource" }, "createdBy": { "description": "Relation to the user who created this language. Embed via a \"select-language: createdBy\" header.", "$ref": "#/components/schemas/UserResource" }, "modifiedBy": { "description": "Relation to the user who last modified this language. Embed via a \"select-language: modifiedBy\" header.", "$ref": "#/components/schemas/UserResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "A language enabled in this tenant that multi-language fields and labels can store localized values in." }, "LanguageSuggestionsNonResource": { "title": "Language suggestions non resource", "type": "object", "properties": { "languageId": { "type": "string", "description": "Id of the language this reply is for", "format": "uuid" }, "suggestions": { "type": "array", "items": { "$ref": "#/components/schemas/SuggestionNonResource" }, "description": "List of the suggestions for this language" } }, "description": "Represents a reply to a suggestion request for one specific language" }, "Link": { "title": "Link", "type": "object", "properties": { "href": { "type": "string", "format": "uri" } }, "description": "A hypermedia link to a related resource." }, "LinkedClassificationCollectionResource": { "title": "Linked classification collection resource", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/LinkedClassificationResource" }, "description": "A collection of resource items." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of a non-paged collection of linked classifications" }, "LinkedClassificationResource": { "title": "Linked classification resource", "type": "object", "properties": { "id": { "type": "string", "description": "Identifier of the linked classification.", "format": "uuid" }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelNonResource" }, "description": "A collection of Label items." }, "depth": { "type": "integer", "description": "Depth of the linked classification. The depth of the top level classification is 0.", "format": "int32" }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of an ancestor of a single classification" }, "LinkedRecordCollectionResource": { "title": "Linked record collection resource", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/LinkedRecordResource" }, "description": "A collection of resource items." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of a non-paged collection of linked records" }, "LinkedRecordResource": { "title": "Linked record resource", "type": "object", "properties": { "id": { "type": "string", "description": "Id of the linked record.", "format": "uuid" }, "depth": { "type": "integer", "description": "Depth of the linked record relative to the record being queried. The depth of the top-level record is 0.", "format": "int32" }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of an ancestor of a single record" }, "LinkedVersionInfoCollectionResource": { "title": "Linked version info collection resource", "type": "object", "properties": { "pageNumber": { "type": [ "null", "integer" ], "description": "The current page of this paged collection.", "format": "int32" }, "pageSize": { "type": [ "null", "integer" ], "description": "The current page size of this paged collection.", "format": "int32" }, "skip": { "type": [ "null", "integer" ], "description": "The current skip size of this paged collection.", "format": "int32" }, "take": { "type": [ "null", "integer" ], "description": "The current take size of this paged collection.", "format": "int32" }, "totalCount": { "type": "integer", "description": "The total count of items in this paged collection, not just on the current page.", "format": "int64" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/LinkedVersionInfoNonResource" }, "description": "One page of this paged collection, which is a subcollection of the complete collection." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" }, "first": { "description": "A link to the first page of this paged collection.", "$ref": "#/components/schemas/Link" }, "prev": { "description": "A link to the previous page of this paged collection.", "$ref": "#/components/schemas/Link" }, "next": { "description": "A link to the next page of this paged collection.", "$ref": "#/components/schemas/Link" }, "last": { "description": "A link to the last page of this paged collection.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of a paged collection of linked version information" }, "LinkedVersionInfoNonResource": { "title": "Linked version info non resource", "type": "object", "properties": { "recordId": { "type": "string", "description": "The Record id the FileVersion belongs to.", "format": "uuid" }, "fileId": { "type": "string", "description": "The File id the FileVersion belongs to.", "format": "uuid" }, "fileVersionId": { "type": "string", "description": "The id of the FileVersion that is linked.", "format": "uuid" }, "linkSourceVersionId": { "type": "string", "description": "The id of the FileVersion this link belongs to.", "format": "uuid" }, "linkType": { "enum": [ "Contains", "UsedIn" ], "type": "string", "description": "This type refers to whether the FileVersionId is used in linkSourceVersionId or Contains a link to linkSourceVersionId." } }, "description": "Representation of a LinkedVersionInfo that can either be FileVersion publication item or a FileVersion publication." }, "LocalizedValueModel": { "title": "Localized value model", "oneOf": [ { "title": "Single value", "type": "object", "properties": { "languageId": { "type": "string", "description": "The id of the language this value applies to.", "format": "uuid" }, "clear": { "type": "boolean", "description": "When set to true, clears the value for this language." }, "aIInfluenced": { "type": "boolean", "description": "Whether this value was generated or influenced by AI." }, "value": { "type": "string", "description": "The single-value content of the field for this language." }, "hasDay": { "type": "boolean", "description": "Whether the date value includes a day component." }, "hasMonth": { "type": "boolean", "description": "Whether the date value includes a month component." } } }, { "title": "Multiple values", "type": "object", "properties": { "languageId": { "type": "string", "description": "The id of the language this value applies to.", "format": "uuid" }, "clear": { "type": "boolean", "description": "When set to true, clears the value for this language." }, "aIInfluenced": { "type": "boolean", "description": "Whether this value was generated or influenced by AI." }, "values": { "description": "The multi-value content of the field for this language.", "$ref": "#/components/schemas/ObjectArrayParameterModel" } } }, { "title": "Record links", "type": "object", "properties": { "languageId": { "type": "string", "description": "The id of the language this value applies to.", "format": "uuid" }, "clear": { "type": "boolean", "description": "When set to true, clears the value for this language." }, "aIInfluenced": { "type": "boolean", "description": "Whether this value was generated or influenced by AI." }, "links": { "description": "Record links stored in this field for this language.", "$ref": "#/components/schemas/RecordLinkItemArrayParameterModel" }, "parents": { "description": "Parent record links stored in this field for this language.", "$ref": "#/components/schemas/RecordLinkItemArrayParameterModel" }, "children": { "description": "Child record links stored in this field for this language.", "$ref": "#/components/schemas/RecordLinkItemArrayParameterModel" } } }, { "title": "Hyperlinks", "type": "object", "properties": { "languageId": { "type": "string", "description": "The id of the language this value applies to.", "format": "uuid" }, "clear": { "type": "boolean", "description": "When set to true, clears the value for this language." }, "aIInfluenced": { "type": "boolean", "description": "Whether this value was generated or influenced by AI." }, "hyperlinks": { "description": "Hyperlinks stored in this field for this language.", "$ref": "#/components/schemas/HyperlinkItemArrayParameterModel" } } } ], "description": "The value of a field for a single language." }, "MaintenanceActionNonResource": { "title": "Maintenance action non resource", "type": "object", "properties": { "action": { "description": "Type of the action.", "$ref": "#/components/schemas/MaintenanceJobAction" }, "label": { "type": "string", "description": "Name of the action." }, "description": { "type": "string", "description": "Short description of the action." }, "parameters": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Action-specific parameters." } }, "description": "Representation of an action that can be applied on targets of a maintenance job." }, "MaintenanceJobAction": { "title": "Maintenance job action", "enum": [ "AppendTextField", "AssignWatermarkRecord", "ClassificationCopy", "ClassificationMove", "ClassifyRecord", "Delete", "ForceDirty", "OverwriteField", "RecordSave", "RefreshFileRecord", "RefreshFileTypeRecord", "ReplaceTextField", "ResetToDefaultField", "Touch", "UnclassifyRecord", "ChangeContentType", "Field", "UpdateClassMappings", "BasicAction", "CreatePresetCrops", "AprimoAI", "CreateReviewFile", "AppendToField", "RemoveFromField", "CreateRenditions", "ChangeRecordStatus", "RuleMaintenance", "FileVersionRunMediaEngine", "FileVersionCalculateCrc", "FileVersionMoveFilesToFinalStore", "ClassificationSave", "PackageIngestion", "ResetFileState", "TrimVideo", "RefreshUrlToPdf", "PredictiveMetadata", "EnhancedCaptioning", "ResolveContentType", "CropImage", "ResizeImage", "ResizeImageWithClippingPath", "TranscodeVideo", "TrimVideoOrder", "CreatePackage", "RefreshOnAkamaiCdn", "RefreshOnPublicCdn", "UpdateXmpMetaData", "CreatePublicLinks", "DeletePublicLinks", "CropImageOrder", "PackageDownloadOrder", "ResizeWithClippingPath", "RunReviewAgent", "GenerateContactSheet", "TranslateSubtitle", "ChangeCollectionOwner", "ChangeCollectionStatus" ], "type": "string", "x-enum-descriptions": [ "Appends text to a text field.", "Assigns a watermark to a record.", "Copies a record to another classification.", "Moves a record to another classification.", "Classifies a record.", "Deletes the target.", "Marks a record as dirty so it is reprocessed.", "Overwrites the value of a field.", "Saves a record.", "Refreshes the file for a record.", "Refreshes the file type for a record.", "Replaces text in a text field.", "Resets a field to its default value.", "Touches a record without otherwise modifying it.", "Removes a record from its classification.", "Changes the content type of a record.", "Updates a single field on a record.", "Updates classification mappings.", "Executes a basic, non-parameterized action.", "Creates the preset crops for a record.", "Runs an Aprimo AI operation on a record.", "Creates a review file for a record.", "Appends a value to a field.", "Removes a value from a field.", "Creates rendition(s) of a record's master file (format conversion, resolution change, background removal, etc.), stored in the record's additionalfiles collection. Which renditions are created is configured via the presets named in the action's parameters; presets are configured via the .renditionPreset setting, e.g. a preset with aiActions=\"removeBackground\" creates a background-removed rendition.", "Changes the lifecycle status of a record.", "Runs rule maintenance for a record.", "Runs the media engine for a file version.", "Calculates the CRC checksum for a file version.", "Moves the files of a file version to their final store.", "Saves a classification.", "Ingests a package.", "Resets the state of a file.", "Creates a trimmed segment of a video, storing it in the record's additionalfiles collection. Video files only.", "Refreshes the URL-to-PDF rendition of a record.", "Generates predictive metadata for a record.", "Generates enhanced captioning for a record.", "Resolves the content type of a record.", "Crops a region of an image, storing the crop in the record's additionalfiles collection. Image files only.", "Resizes an image.", "Resizes an image using a clipping path.", "Transcodes a video.", "Trims a video as part of an order.", "Creates a package.", "Refreshes content on the Akamai CDN.", "Refreshes content on the public CDN.", "Updates XMP metadata.", "Creates public links.", "Deletes public links.", "Crops an image as part of an order.", "Packages a download order.", "Resizes an image with a clipping path as part of an order.", "Runs a review agent on a record.", "Generates a contact sheet.", "Translates a subtitle.", "Changes the owner of a collection.", "Changes the lifecycle status of a collection." ] }, "MaintenanceJobPagedCollectionResource": { "title": "Maintenance job paged collection resource", "type": "object", "properties": { "pageNumber": { "type": [ "null", "integer" ], "description": "The current page of this paged collection.", "format": "int32" }, "pageSize": { "type": [ "null", "integer" ], "description": "The current page size of this paged collection.", "format": "int32" }, "skip": { "type": [ "null", "integer" ], "description": "The current skip size of this paged collection.", "format": "int32" }, "take": { "type": [ "null", "integer" ], "description": "The current take size of this paged collection.", "format": "int32" }, "totalCount": { "type": "integer", "description": "The total count of items in this paged collection, not just on the current page.", "format": "int64" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/MaintenanceJobResource" }, "description": "One page of this paged collection, which is a subcollection of the complete collection." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" }, "first": { "description": "A link to the first page of this paged collection.", "$ref": "#/components/schemas/Link" }, "prev": { "description": "A link to the previous page of this paged collection.", "$ref": "#/components/schemas/Link" }, "next": { "description": "A link to the next page of this paged collection.", "$ref": "#/components/schemas/Link" }, "last": { "description": "A link to the last page of this paged collection.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of a paged collection of maintenance jobs" }, "MaintenanceJobResource": { "title": "Maintenance job resource", "type": "object", "properties": { "actions": { "type": "array", "items": { "$ref": "#/components/schemas/MaintenanceActionNonResource" }, "description": "A collection which defines Maintenance Actions. This job should execute on all the specified targets." }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorMessageNonResource" }, "description": "A collection with Errors in this job executed on all the specified targets." }, "targetsCount": { "type": "integer", "description": "Count of the targets.", "format": "int32" }, "creatorEmail": { "type": "string", "description": "E-mail address for this job" }, "disableNotification": { "type": "boolean", "description": "Value indicating whether or not notification is enabled on this job" }, "earliestStartDate": { "type": [ "null", "string" ], "description": "The earliest date in utc time on which this job can be executed.", "format": "date-time" }, "executionTime": { "type": "string", "description": "Time it took for this maintenance job to execute." }, "id": { "type": "string", "description": "Id of this maintenance job.", "format": "uuid" }, "type": { "type": "string", "description": "Name of this maintenance job." }, "priority": { "enum": [ "High", "Medium", "AuditArchiving", "BuildSearchIndex" ], "type": "string", "description": "Priority of this maintenance job." }, "startedOn": { "type": [ "null", "string" ], "description": "Time on which the execution of this maintenance job started in utc time.", "format": "date-time" }, "status": { "enum": [ "Pending", "Success", "Failed", "PartiallyFailed", "Executing", "Cancelled", "Scheduled", "Queued", "AsyncPending", "AsyncExecuting" ], "type": "string", "description": "Status of this maintenance job." }, "message": { "type": [ "null", "string" ], "description": "Error message that describes why this maintenance job failed. Returns null if this maintenance job hasn't been executed yet." }, "failedTargetsCount": { "type": "integer", "description": "Count of the failed targets.", "format": "int32" }, "createdOn": { "type": "string", "description": "Creation datetime in UTC time.", "format": "date-time" }, "_links": { "type": "object", "properties": { "targets": { "description": "Relation to a collection of maintenance job targets.", "$ref": "#/components/schemas/Link" }, "createdBy": { "description": "Relation to the user who created this maintenance job.", "$ref": "#/components/schemas/Link" }, "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "targets": { "description": "Relation to a collection of maintenance job targets. Embed via a \"select-maintenancejob: targets\" header.", "$ref": "#/components/schemas/MaintenanceTargetCollectionResource" }, "createdBy": { "description": "Relation to the user who created this maintenance job. Embed via a \"select-maintenancejob: createdBy\" header.", "$ref": "#/components/schemas/UserResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "An asynchronous background job that applies one or more maintenance actions (e.g. reprocessing or reindexing) to a set of target records or files, tracked through to completion with status, timing, and per-target results." }, "MaintenanceStatus": { "title": "Maintenance status", "enum": [ "Pending", "Success", "Failed", "PartiallyFailed", "Executing", "Cancelled", "Scheduled", "Queued", "AsyncPending", "AsyncExecuting" ], "type": "string", "x-enum-descriptions": [ "This job still needs to be executed.", "All targets of this job have been successfully executed.", "All targets of this job failed to execute successfully.", "At least one target of this job failed to execute successfully.", "This job is currently being executed.", "This job has been cancelled.", "This job has been scheduled.", "This job has been queued.", "This job still needs to be executed on an external system.", "This job is executing on an external system." ] }, "MaintenanceTargetCollectionResource": { "title": "Maintenance target collection resource", "type": "object", "properties": { "items": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/RecordMaintenanceTargetResource" }, { "$ref": "#/components/schemas/ClassificationMaintenanceTargetResource" }, { "$ref": "#/components/schemas/RuleMaintenanceTargetResource" }, { "$ref": "#/components/schemas/ReportingMaintenanceTargetResource" }, { "$ref": "#/components/schemas/OrderTargetResource" } ] }, "description": "A collection of resource items." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "A collection of maintenance targets." }, "MaintenanceTargetResourceStatus": { "title": "Maintenance target resource status", "enum": [ "Pending", "Succeeded", "Failed", "PartiallyFailed" ], "type": "string", "x-enum-descriptions": [ "The target has not yet been executed.", "The target was executed successfully.", "The target failed to execute.", "The target partially failed to execute." ] }, "ManagedContentPreviewMode": { "title": "Managed content preview mode", "enum": [ "Preserve", "Manual", "NotSet" ], "type": "string", "x-enum-descriptions": [ "The existing preview is preserved as-is.", "The preview is generated manually.", "No preview mode has been set." ] }, "ManagedContentPreviewModel": { "title": "Managed content preview model", "type": "object", "properties": { "token": { "type": "string", "description": "Token identifying the preview." }, "mode": { "description": "Mode controlling how the preview is generated.", "$ref": "#/components/schemas/ManagedContentPreviewMode" } }, "description": "Preview settings for managed content." }, "ManagedContentState": { "title": "Managed content state", "enum": [ "Draft", "Published" ], "type": "string", "x-enum-descriptions": [ "The managed content is a draft and not yet published.", "The managed content is published." ] }, "MarkCommentsAsReadCommand": { "title": "Mark comments as read command", "type": "object", "properties": { "lastReadCommentDate": { "type": "string", "description": "Comments created on or before this date are marked as read.", "format": "date-time" } }, "description": "Marks a collection's comments as read up to a given date." }, "MasterPreviewChangedRuleConditionModel": { "title": "Master preview changed rule condition model", "type": "object", "properties": { "index": { "type": "integer", "description": "Index of the condition within the rule's condition collection", "format": "int32" }, "conditionType": { "description": "Type of condition to be evaluated.", "$ref": "#/components/schemas/RuleConditionDataType" } }, "description": "Model for MasterPreviewChanged rule condition" }, "MasterPreviewChangedRuleConditionNonResource": { "title": "Master preview changed rule condition non resource", "type": "object", "properties": { "index": { "type": "integer", "description": "Index of a rule condition in collection", "format": "int32" }, "conditionType": { "description": "Data type of this rule condition", "$ref": "#/components/schemas/RuleConditionDataType" } }, "description": "Representation of record master preview changed rule condition" }, "MasterPreviewExistsRuleConditionModel": { "title": "Master preview exists rule condition model", "type": "object", "properties": { "index": { "type": "integer", "description": "Index of the condition within the rule's condition collection", "format": "int32" }, "conditionType": { "description": "Type of condition to be evaluated.", "$ref": "#/components/schemas/RuleConditionDataType" } }, "description": "Model for MasterPreviewExists rule condition" }, "MasterPreviewExistsRuleConditionNonResource": { "title": "Master preview exists rule condition non resource", "type": "object", "properties": { "index": { "type": "integer", "description": "Index of a rule condition in collection", "format": "int32" }, "conditionType": { "description": "Data type of this rule condition", "$ref": "#/components/schemas/RuleConditionDataType" } }, "description": "Representation of record master preview exists rule condition" }, "MetadataModel": { "title": "Metadata model", "type": "object", "properties": { "name": { "type": "string", "description": "The name of the metadata schema, matching a schema defined in the \".dataExchangeSchemas\" setting. The schema defines the CSV's columns and how each maps to a record field, property, or classification." }, "token": { "type": "string", "description": "The upload token returned when the metadata CSV file was uploaded through the upload service." } }, "description": "Bulk metadata to apply to the record from an uploaded CSV file, parsed according to a named schema. Upload the CSV through the upload service (see Uploading files) to get a token, then set that token here alongside the schema name to have the record's fields, properties, and classifications populated from the matching CSV row on create or update. The CSV must be semicolon-delimited with a header row, values wrapped in quotes, and multiple values within one field separated by commas (e.g. \"Blue,Green\"). One column must map to the file name and serves as the row-matching key. Date values are parsed culture-specifically (US vs. European formats differ); classification values accept either a GUID or a full label path; option list values must use the UI display label, not the internal name. The schema referenced by Name defines how each column maps to a record field, property, or classification." }, "ModifiableByResourceOfTResourceRelationCreatableAndTResourceRelationModifiable": { "title": "Modifiable by resource of t resource relation creatable and t resource relation modifiable", "type": "object", "properties": { "modifiedOn": { "type": "string", "description": "Last modification datetime in UTC time.", "format": "date-time" }, "createdOn": { "type": "string", "description": "Creation datetime in UTC time.", "format": "date-time" }, "_links": { "type": "object", "properties": { "modifiedBy": { "description": "User that last modified this resource.", "$ref": "#/components/schemas/Link" }, "createdBy": { "description": "User that created this resource.", "$ref": "#/components/schemas/Link" }, "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Base representation of a modifiable by resource" }, "MovieAddedWithoutMoviePreviewRuleConditionModel": { "title": "Movie added without movie preview rule condition model", "type": "object", "properties": { "moviePreviewExtension": { "type": "string", "description": "Extension of the expected movie preview" }, "index": { "type": "integer", "description": "Index of the condition within the rule's condition collection", "format": "int32" }, "conditionType": { "description": "Type of condition to be evaluated.", "$ref": "#/components/schemas/RuleConditionDataType" } }, "description": "Model for MovieAddedWithoutMoviePreview rule condition" }, "MovieAddedWithoutMoviePreviewRuleConditionNonResource": { "title": "Movie added without movie preview rule condition non resource", "type": "object", "properties": { "moviePreviewExtension": { "type": "string", "description": "Extension of movie without preview" }, "index": { "type": "integer", "description": "Index of a rule condition in collection", "format": "int32" }, "conditionType": { "description": "Data type of this rule condition", "$ref": "#/components/schemas/RuleConditionDataType" } }, "description": "Representation of Movie Added Without Movie Preview rule condition" }, "MultiLineTextFieldDefinitionCreateCommand": { "title": "Multi line text field definition create command", "type": "object", "properties": { "maximumLength": { "type": "integer", "description": "Maximum number of characters allowed for the field value.", "format": "int32" }, "minimumLength": { "type": "integer", "description": "Minimum number of characters required for the field value.", "format": "int32" }, "regularExpression": { "type": "string", "description": "Regular expression the field value must match." }, "aIEnabled": { "type": "boolean", "description": "When set to true, AI-based content generation is enabled for this field." }, "metadataPredictionEnabled": { "type": "boolean", "description": "When set to true, this field's value can be predicted using AI-based metadata prediction." }, "hints": { "type": "string", "description": "Hints used to guide AI-based metadata prediction for this field." }, "dataType": { "description": "Data type of the field definition. Determines which other properties apply.", "$ref": "#/components/schemas/FieldDefinitionType" }, "enabledLanguages": { "description": "Languages in which this field is enabled. Use AddOrUpdate to add or update members, or Remove to remove them.", "$ref": "#/components/schemas/EditableIdCollectionModel" }, "indexed": { "type": "boolean", "description": "When set to true, the field is indexed for search." }, "inlineStyle": { "type": "string", "description": "Inline CSS style applied to the field in the DAM UI." }, "isReadOnly": { "type": "boolean", "description": "When set to true, the field cannot be edited." }, "isRequired": { "type": "boolean", "description": "When set to true, the field is required." }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelModel" }, "description": "Multi-language labels for the name of this field." }, "languageMode": { "type": "string", "description": "Language mode of the field." }, "memberships": { "description": "Field groups this field is a member of. Use AddOrUpdate to add or update members, or Remove to remove them.", "$ref": "#/components/schemas/EditableIdCollectionModel" }, "name": { "type": "string", "description": "Name of the field." }, "scope": { "type": "string", "description": "Scope of the field." }, "sortIndex": { "type": "integer", "description": "Sort index used to order the field relative to other fields.", "format": "int32" }, "tag": { "type": "string", "description": "Tag associated with the field." }, "defaultValue": { "type": "string", "description": "Default value assigned to the field." }, "resetToDefaultTriggers": { "type": "array", "items": { "type": "string" }, "description": "Names of the triggers that reset the field to its default value." }, "resetToDefaultFields": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Ids of the fields that reset this field to its default value when they change." }, "validation": { "type": "string", "description": "Validation expression applied to the field value." }, "validationErrorMessage": { "type": "string", "description": "Error message shown when validation fails." }, "validationTrigger": { "type": "string", "description": "Trigger that determines when validation is applied." }, "storageMode": { "type": "string", "description": "Storage mode of the field." }, "helpTexts": { "type": "array", "items": { "$ref": "#/components/schemas/HelpTextModel" }, "description": "Multi-language help texts for this field." } }, "description": "Command to create a multi-line text field definition." }, "MultiLineTextFieldDefinitionResource": { "title": "Multi line text field definition resource", "type": "object", "properties": { "minimumLength": { "type": "integer", "description": "The minimum length for the field.", "format": "int32" }, "maximumLength": { "type": "integer", "description": "The maximum length for the field.", "format": "int32" }, "regularExpression": { "type": "string", "description": "A regular expression for validating the field." }, "aIEnabled": { "type": "boolean", "description": "Indicates whether to allow AI enhancement." }, "metadataPredictionEnabled": { "type": "boolean", "description": "Indicates whether the field can be predicted by the AI." }, "hints": { "type": "string", "description": "AI Prediction hint for this field." }, "label": { "type": "string", "description": "Label of this field." }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelNonResource" }, "description": "A collection of Label items." }, "dataType": { "$ref": "#/components/schemas/FieldDataType" }, "scope": { "enum": [ "RecordContentGlobal", "RecordContentClassDependent", "RecordContentFloating", "ClassificationProfileClassDependent", "UserGlobal", "FileFileTypeDependent", "FileFloating", "IndexerTaskGlobal", "FileGlobal", "ClassificationProfileFloating", "RecordContentContentTypeDependent" ], "type": "string", "description": "Scope." }, "scopeCategory": { "enum": [ "Record", "File", "Classification", "User", "IndexerTask", "MetadataTemplate" ], "type": "string", "description": "Scope category." }, "indexed": { "type": "boolean", "description": "Indicator if searching on this field is enabled." }, "languageMode": { "enum": [ "Single", "Multiple" ], "type": "string", "description": "Language mode of the field." }, "memberships": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Memberships of a field." }, "searchIndexRebuildRequired": { "type": "boolean", "description": "Indicator if a search index rebuild is required." }, "enabledLanguages": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Enabled languages." }, "id": { "type": "string", "description": "Identifier for this field.", "format": "uuid" }, "name": { "type": "string", "description": "Name for this field." }, "isRequired": { "type": "boolean", "description": "Indicates whether this field is required." }, "isReadOnly": { "type": "boolean", "description": "Indicates whether this field is read only." }, "isUniqueIdentifier": { "type": "boolean", "description": "Indicates whether this field is a unique identifier." }, "inlineStyle": { "type": "string", "description": "Inline CSS style applied to this field." }, "sortIndex": { "type": "integer", "description": "Sorting index of this field.", "format": "int32" }, "tag": { "type": "string", "description": "Tag for this field containing extra information. Opt-in: returned only when requested. Include via a \"select-fielddefinition: Tag\" header." }, "createdOn": { "type": "string", "description": "Created on the specified date in UTC time", "format": "date-time" }, "modifiedOn": { "type": "string", "description": "Modified on the specified date in UTC time", "format": "date-time" }, "defaultValue": { "type": "string", "description": "Default value of this field." }, "resetToDefaultTriggers": { "type": "array", "items": { "enum": [ "None", "OnNewField", "OnLoad", "OnSave", "OnAnyFileChange", "OnReclassifyRecord", "OnAnyChange", "OnFieldChange", "OnMasterFileChange", "OnCurrentFileChange", "OnFieldDefinitionChanged", "OnDuplicateRecord", "OnRecordStatusChange" ], "type": "string" }, "description": "'reset to default triggers' value of this field." }, "validation": { "type": "string", "description": "Validation of this field." }, "validationErrorMessage": { "type": "string", "description": "Error message of this field." }, "validationTrigger": { "enum": [ "None", "WhenNeeded", "Always" ], "type": "string", "description": "Trigger that determines when validation is evaluated for this field." }, "storageMode": { "enum": [ "None", "NonEmptyValues", "AllValues", "LogChanges" ], "type": "string", "description": "Storage mode of this field." }, "resetToDefaultFields": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Fields that trigger this field to be reset back to its default value. This is only used if \"ResetToDefaultTriggers\" is set to \"OnFieldChange\"." }, "helpText": { "type": "string", "description": "Help text of this field." }, "helpTexts": { "type": "array", "items": { "$ref": "#/components/schemas/HelpTextNonResource" }, "description": "A collection of HelpText items." }, "_links": { "type": "object", "properties": { "createdBy": { "description": "Relation to the user who created this field definition.", "$ref": "#/components/schemas/Link" }, "modifiedBy": { "description": "Relation to the user who last modified this field definition.", "$ref": "#/components/schemas/Link" }, "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "createdBy": { "description": "Relation to the user who created this field definition. Embed via a \"select-fielddefinition: createdBy\" header.", "$ref": "#/components/schemas/UserResource" }, "modifiedBy": { "description": "Relation to the user who last modified this field definition. Embed via a \"select-fielddefinition: modifiedBy\" header.", "$ref": "#/components/schemas/UserResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "Representation of the definition of a multi-line text field" }, "MultiLineTextFieldResource": { "title": "Multi line text field resource", "type": "object", "properties": { "dataType": { "$ref": "#/components/schemas/FieldDataType" }, "fieldName": { "type": "string", "description": "Name of this field." }, "label": { "type": "string", "description": "Label of this field." }, "id": { "type": "string", "description": "Id of this field.", "format": "uuid" }, "localizedValues": { "type": "array", "items": { "$ref": "#/components/schemas/MultiLineTextFieldValue" }, "description": "Language specific data of this field." }, "inheritanceState": { "enum": [ "None", "Inherited" ], "type": [ "null", "string" ], "description": "Inheritance State of this field. Opt-in: returned only when requested. Include via a \"select-field: InheritanceState\" header." }, "inheritable": { "type": [ "null", "boolean" ], "description": "Whether the field value can be used as a parent in inheritance hierarchy. Opt-in: returned only when requested. Include via a \"select-field: Inheritable\" header." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" }, "definition": { "description": "Relation to the field definition.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "definition": { "description": "Relation to the field definition. Embed via a \"select-multilinetextfield: definition\" header.", "$ref": "#/components/schemas/FieldDefinitionResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "Representation of a MultiLineTextField" }, "MultiLineTextFieldValue": { "title": "Multi line text field value", "type": "object", "properties": { "value": { "type": "string", "description": "Text which can contain new-line characters." }, "aIInfluenced": { "type": "boolean", "description": "Flag to indicate whether the value has come from AI." }, "languageId": { "type": "string", "description": "The language id.", "format": "uuid" }, "readOnly": { "type": [ "null", "boolean" ], "description": "Tells if the field is read-only." }, "modifiedOn": { "type": "string", "description": "Contains the date/time when the field is last modified.", "format": "date-time" } }, "description": "Language-specific MultiLineTextField value." }, "MultilingualFieldValuesChangedRuleConditionModel": { "title": "Multilingual field values changed rule condition model", "type": "object", "properties": { "fieldDefinitionIds": { "type": "array", "items": { "type": [ "null", "string" ], "format": "uuid" }, "description": "Ids of the multilingual field definitions to check" }, "index": { "type": "integer", "description": "Index of the condition within the rule's condition collection", "format": "int32" }, "conditionType": { "description": "Type of condition to be evaluated.", "$ref": "#/components/schemas/RuleConditionDataType" } }, "description": "Model for MultilingualFieldValuesChanged rule condition" }, "MultilingualFieldValuesChangedRuleConditionNonResource": { "title": "Multilingual field values changed rule condition non resource", "type": "object", "properties": { "fieldDefinitionIds": { "type": "array", "items": { "type": [ "null", "string" ], "format": "uuid" }, "description": "Ids of the multilingual fields whose values are watched" }, "index": { "type": "integer", "description": "Index of a rule condition in collection", "format": "int32" }, "conditionType": { "description": "Data type of this rule condition", "$ref": "#/components/schemas/RuleConditionDataType" } }, "description": "Representation of Multilingual Field Values Changed rule condition" }, "NullResource": { "title": "Null resource", "type": "object", "properties": { "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "This represents a Null embedded resource" }, "NumericFieldDefinitionCreateCommand": { "title": "Numeric field definition create command", "type": "object", "properties": { "accuracy": { "type": "number", "description": "Number of decimal places the field value is rounded to.", "format": "double" }, "range": { "type": "string", "description": "Range of allowed values for the field." }, "metadataPredictionEnabled": { "type": "boolean", "description": "When set to true, this field's value can be predicted using AI-based metadata prediction." }, "hints": { "type": "string", "description": "Hints used to guide AI-based metadata prediction for this field." }, "dataType": { "description": "Data type of the field definition. Determines which other properties apply.", "$ref": "#/components/schemas/FieldDefinitionType" }, "enabledLanguages": { "description": "Languages in which this field is enabled. Use AddOrUpdate to add or update members, or Remove to remove them.", "$ref": "#/components/schemas/EditableIdCollectionModel" }, "indexed": { "type": "boolean", "description": "When set to true, the field is indexed for search." }, "inlineStyle": { "type": "string", "description": "Inline CSS style applied to the field in the DAM UI." }, "isReadOnly": { "type": "boolean", "description": "When set to true, the field cannot be edited." }, "isRequired": { "type": "boolean", "description": "When set to true, the field is required." }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelModel" }, "description": "Multi-language labels for the name of this field." }, "languageMode": { "type": "string", "description": "Language mode of the field." }, "memberships": { "description": "Field groups this field is a member of. Use AddOrUpdate to add or update members, or Remove to remove them.", "$ref": "#/components/schemas/EditableIdCollectionModel" }, "name": { "type": "string", "description": "Name of the field." }, "scope": { "type": "string", "description": "Scope of the field." }, "sortIndex": { "type": "integer", "description": "Sort index used to order the field relative to other fields.", "format": "int32" }, "tag": { "type": "string", "description": "Tag associated with the field." }, "defaultValue": { "type": "string", "description": "Default value assigned to the field." }, "resetToDefaultTriggers": { "type": "array", "items": { "type": "string" }, "description": "Names of the triggers that reset the field to its default value." }, "resetToDefaultFields": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Ids of the fields that reset this field to its default value when they change." }, "validation": { "type": "string", "description": "Validation expression applied to the field value." }, "validationErrorMessage": { "type": "string", "description": "Error message shown when validation fails." }, "validationTrigger": { "type": "string", "description": "Trigger that determines when validation is applied." }, "storageMode": { "type": "string", "description": "Storage mode of the field." }, "helpTexts": { "type": "array", "items": { "$ref": "#/components/schemas/HelpTextModel" }, "description": "Multi-language help texts for this field." } }, "description": "Command to create a numeric field definition." }, "NumericFieldDefinitionResource": { "title": "Numeric field definition resource", "type": "object", "properties": { "accuracy": { "type": "number", "description": "Accuracy.", "format": "double" }, "range": { "type": "string", "description": "Range." }, "metadataPredictionEnabled": { "type": "boolean", "description": "Indicates whether the field can be predicted by the AI." }, "hints": { "type": "string", "description": "AI Prediction hint for this field." }, "label": { "type": "string", "description": "Label of this field." }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelNonResource" }, "description": "A collection of Label items." }, "dataType": { "$ref": "#/components/schemas/FieldDataType" }, "scope": { "enum": [ "RecordContentGlobal", "RecordContentClassDependent", "RecordContentFloating", "ClassificationProfileClassDependent", "UserGlobal", "FileFileTypeDependent", "FileFloating", "IndexerTaskGlobal", "FileGlobal", "ClassificationProfileFloating", "RecordContentContentTypeDependent" ], "type": "string", "description": "Scope." }, "scopeCategory": { "enum": [ "Record", "File", "Classification", "User", "IndexerTask", "MetadataTemplate" ], "type": "string", "description": "Scope category." }, "indexed": { "type": "boolean", "description": "Indicator if searching on this field is enabled." }, "languageMode": { "enum": [ "Single", "Multiple" ], "type": "string", "description": "Language mode of the field." }, "memberships": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Memberships of a field." }, "searchIndexRebuildRequired": { "type": "boolean", "description": "Indicator if a search index rebuild is required." }, "enabledLanguages": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Enabled languages." }, "id": { "type": "string", "description": "Identifier for this field.", "format": "uuid" }, "name": { "type": "string", "description": "Name for this field." }, "isRequired": { "type": "boolean", "description": "Indicates whether this field is required." }, "isReadOnly": { "type": "boolean", "description": "Indicates whether this field is read only." }, "isUniqueIdentifier": { "type": "boolean", "description": "Indicates whether this field is a unique identifier." }, "inlineStyle": { "type": "string", "description": "Inline CSS style applied to this field." }, "sortIndex": { "type": "integer", "description": "Sorting index of this field.", "format": "int32" }, "tag": { "type": "string", "description": "Tag for this field containing extra information. Opt-in: returned only when requested. Include via a \"select-fielddefinition: Tag\" header." }, "createdOn": { "type": "string", "description": "Created on the specified date in UTC time", "format": "date-time" }, "modifiedOn": { "type": "string", "description": "Modified on the specified date in UTC time", "format": "date-time" }, "defaultValue": { "type": "string", "description": "Default value of this field." }, "resetToDefaultTriggers": { "type": "array", "items": { "enum": [ "None", "OnNewField", "OnLoad", "OnSave", "OnAnyFileChange", "OnReclassifyRecord", "OnAnyChange", "OnFieldChange", "OnMasterFileChange", "OnCurrentFileChange", "OnFieldDefinitionChanged", "OnDuplicateRecord", "OnRecordStatusChange" ], "type": "string" }, "description": "'reset to default triggers' value of this field." }, "validation": { "type": "string", "description": "Validation of this field." }, "validationErrorMessage": { "type": "string", "description": "Error message of this field." }, "validationTrigger": { "enum": [ "None", "WhenNeeded", "Always" ], "type": "string", "description": "Trigger that determines when validation is evaluated for this field." }, "storageMode": { "enum": [ "None", "NonEmptyValues", "AllValues", "LogChanges" ], "type": "string", "description": "Storage mode of this field." }, "resetToDefaultFields": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Fields that trigger this field to be reset back to its default value. This is only used if \"ResetToDefaultTriggers\" is set to \"OnFieldChange\"." }, "helpText": { "type": "string", "description": "Help text of this field." }, "helpTexts": { "type": "array", "items": { "$ref": "#/components/schemas/HelpTextNonResource" }, "description": "A collection of HelpText items." }, "_links": { "type": "object", "properties": { "createdBy": { "description": "Relation to the user who created this field definition.", "$ref": "#/components/schemas/Link" }, "modifiedBy": { "description": "Relation to the user who last modified this field definition.", "$ref": "#/components/schemas/Link" }, "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "createdBy": { "description": "Relation to the user who created this field definition. Embed via a \"select-fielddefinition: createdBy\" header.", "$ref": "#/components/schemas/UserResource" }, "modifiedBy": { "description": "Relation to the user who last modified this field definition. Embed via a \"select-fielddefinition: modifiedBy\" header.", "$ref": "#/components/schemas/UserResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "Representation of the definition of a numeric field" }, "NumericFieldFacetModel": { "title": "Numeric field facet model", "type": "object", "properties": { "maximumFacetValues": { "type": [ "null", "integer" ], "description": "Maximum number of facet values returned.", "format": "int32" }, "fieldId": { "type": [ "null", "string" ], "description": "The id of the field this facet should operate on.", "format": "uuid" }, "filters": { "type": "array", "items": { "type": "number", "format": "double" }, "description": "Filters allow you to limit the hits returned without affecting facets. If filters are specified, the aggregated counts in the facets remain the same. However, only records that match the filter criteria specified in the facet are returned. The parameter type of the filters depends on the facet type, but is always the same type as explicitValues/explicitRanges." }, "explicitValues": { "type": "array", "items": { "type": "number", "format": "double" }, "description": "A list of values. When specified, only shows facets corresponding to the specified values. If not specified, all occurring values are included." }, "explicitRanges": { "type": "array", "items": { "type": "number", "format": "double" }, "description": "Allows for the explicit specification of ranges to include in the facet. If explicitRanges is specified, you cannot specify rangeStart, rangeEnd, or spans (on the concrete range facet type)." }, "name": { "type": "string", "description": "A textual identifier for this facet, used only by the client to correlate requests with responses." }, "type": { "enum": [ "NumericField", "NumericFieldRange", "Classification", "CreatedBy", "ModifiedBy", "FileType", "OptionListField", "TextField", "DateTimeFieldRange", "DateFieldRange", "CreatedOn", "ModifiedOn", "TimeFieldRange", "TextListField", "ContentType", "ClassificationListField", "DateFieldRangeFilter", "NumericFieldRangeFilter" ], "type": "string", "description": "Type of the facet. Depending on facet type, different parameters, combinations of parameters and parameter types are possible." } }, "description": "Facets on a Numeric-type field's discrete values. explicitValues is a list of values." }, "NumericFieldRangeFacetModel": { "title": "Numeric field range facet model", "type": "object", "properties": { "rangeStart": { "type": [ "null", "number" ], "description": "Start of the range to take into account. Cannot be specified if explicitRanges is specified.", "format": "double" }, "rangeEnd": { "type": [ "null", "number" ], "description": "End of the range to take into account. Cannot be specified if explicitRanges is specified.", "format": "double" }, "spans": { "type": "array", "items": { "type": "number", "format": "double" }, "description": "Allows for the explicit specification of spans to divide the facet into. If the range specified is larger than the sum of all spans, the last span is repeated to cover the entire range. Cannot be specified if explicitRanges is specified. If spans is specified, rangeStart and rangeEnd are mandatory." }, "boundaries": { "type": "array", "items": { "enum": [ "None", "Lower", "Upper", "Edge", "All" ], "type": "string" }, "description": "Specifies how to include hits that fall on range or span boundaries. Defaults to None." }, "fieldId": { "type": [ "null", "string" ], "description": "The id of the field this facet should operate on.", "format": "uuid" }, "filters": { "type": "array", "items": { "type": "string" }, "description": "Filters allow you to limit the hits returned without affecting facets. If filters are specified, the aggregated counts in the facets remain the same. However, only records that match the filter criteria specified in the facet are returned. The parameter type of the filters depends on the facet type, but is always the same type as explicitValues/explicitRanges." }, "explicitValues": { "type": "array", "items": { "type": "string" }, "description": "A list of values. When specified, only shows facets corresponding to the specified values. If not specified, all occurring values are included." }, "explicitRanges": { "type": "array", "items": { "type": "string" }, "description": "Allows for the explicit specification of ranges to include in the facet. If explicitRanges is specified, you cannot specify rangeStart, rangeEnd, or spans (on the concrete range facet type)." }, "name": { "type": "string", "description": "A textual identifier for this facet, used only by the client to correlate requests with responses." }, "type": { "enum": [ "NumericField", "NumericFieldRange", "Classification", "CreatedBy", "ModifiedBy", "FileType", "OptionListField", "TextField", "DateTimeFieldRange", "DateFieldRange", "CreatedOn", "ModifiedOn", "TimeFieldRange", "TextListField", "ContentType", "ClassificationListField", "DateFieldRangeFilter", "NumericFieldRangeFilter" ], "type": "string", "description": "Type of the facet. Depending on facet type, different parameters, combinations of parameters and parameter types are possible." } }, "description": "A range facet on a Numeric-type field's values. spans are plain numbers here, not span objects." }, "NumericFieldRangeFilterModel": { "title": "Numeric field range filter model", "type": "object", "properties": { "fieldId": { "type": [ "null", "string" ], "description": "The id of the field this facet should operate on.", "format": "uuid" }, "filters": { "type": "array", "items": { "type": "string" }, "description": "Filters allow you to limit the hits returned without affecting facets. If filters are specified, the aggregated counts in the facets remain the same. However, only records that match the filter criteria specified in the facet are returned. The parameter type of the filters depends on the facet type, but is always the same type as explicitValues/explicitRanges." }, "explicitValues": { "type": "array", "items": { "type": "string" }, "description": "A list of values. When specified, only shows facets corresponding to the specified values. If not specified, all occurring values are included." }, "explicitRanges": { "type": "array", "items": { "type": "string" }, "description": "Allows for the explicit specification of ranges to include in the facet. If explicitRanges is specified, you cannot specify rangeStart, rangeEnd, or spans (on the concrete range facet type)." }, "name": { "type": "string", "description": "A textual identifier for this facet, used only by the client to correlate requests with responses." }, "type": { "enum": [ "NumericField", "NumericFieldRange", "Classification", "CreatedBy", "ModifiedBy", "FileType", "OptionListField", "TextField", "DateTimeFieldRange", "DateFieldRange", "CreatedOn", "ModifiedOn", "TimeFieldRange", "TextListField", "ContentType", "ClassificationListField", "DateFieldRangeFilter", "NumericFieldRangeFilter" ], "type": "string", "description": "Type of the facet. Depending on facet type, different parameters, combinations of parameters and parameter types are possible." } }, "description": "Filters records by a Numeric-type field's value falling in a range, without generating facet value counts. filters contains the range(s) to take into account; if both rangeStart and rangeEnd are specified on a filter, only items in that range are returned, otherwise all items are returned." }, "NumericFieldResource": { "title": "Numeric field resource", "type": "object", "properties": { "dataType": { "$ref": "#/components/schemas/FieldDataType" }, "fieldName": { "type": "string", "description": "Name of this field." }, "label": { "type": "string", "description": "Label of this field." }, "id": { "type": "string", "description": "Id of this field.", "format": "uuid" }, "localizedValues": { "type": "array", "items": { "$ref": "#/components/schemas/NumericFieldValue" }, "description": "Language specific data of this field." }, "inheritanceState": { "enum": [ "None", "Inherited" ], "type": [ "null", "string" ], "description": "Inheritance State of this field. Opt-in: returned only when requested. Include via a \"select-field: InheritanceState\" header." }, "inheritable": { "type": [ "null", "boolean" ], "description": "Whether the field value can be used as a parent in inheritance hierarchy. Opt-in: returned only when requested. Include via a \"select-field: Inheritable\" header." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" }, "definition": { "description": "Relation to the field definition.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "definition": { "description": "Relation to the field definition. Embed via a \"select-numericfield: definition\" header.", "$ref": "#/components/schemas/FieldDefinitionResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "Representation of a NumericField" }, "NumericFieldValue": { "title": "Numeric field value", "type": "object", "properties": { "value": { "type": "string", "description": "Numeric value, represented as a text in InvariantCulture representation (a dot character is used as a decimal separator). Example: \"1234.56\"" }, "aIInfluenced": { "type": "boolean", "description": "Flag to indicate whether the value has come from AI." }, "languageId": { "type": "string", "description": "The language id.", "format": "uuid" }, "readOnly": { "type": [ "null", "boolean" ], "description": "Tells if the field is read-only." }, "modifiedOn": { "type": "string", "description": "Contains the date/time when the field is last modified.", "format": "date-time" } }, "description": "Language-specific NumericField value." }, "NumericSettingDefinitionCreateCommand": { "title": "Numeric setting definition create command", "type": "object", "properties": { "defaultValue": { "type": "integer", "description": "Default value for this numeric setting definition.", "format": "int32" }, "range": { "type": "string", "description": "Range of allowed values for this numeric setting definition." }, "dataType": { "description": "Data type of the setting definition to create. Determines which additional properties apply.", "$ref": "#/components/schemas/SettingDefinitionType" }, "name": { "type": "string", "description": "Name of this setting definition." }, "categoryId": { "type": "string", "description": "Id of the setting category this setting definition belongs to.", "format": "uuid" }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelModel" }, "description": "Multi-language labels for the name of this setting definition." }, "allowSystemSetting": { "type": "boolean", "description": "When set, allows this setting to be configured at the system level." }, "allowUserSetting": { "type": "boolean", "description": "When set, allows this setting to be configured at the user level." }, "roleRequiredForChange": { "type": "string", "description": "Name of the role required to change settings of this definition." }, "userGroupSettingMode": { "enum": [ "None", "MaximumValue", "MinimumValue", "Manual", "FirstValue" ], "type": "string", "description": "Algorithm used to calculate the effective value for user group settings of this definition." }, "helpUrl": { "type": "string", "description": "URL to help documentation for this setting definition." }, "tag": { "type": "string", "description": "Free-form tag for this setting definition." } }, "description": "Creates a new numeric setting definition." }, "NumericSettingDefinitionResource": { "title": "Numeric setting definition resource", "type": "object", "properties": { "defaultValue": { "type": "integer", "description": "Default value of the setting", "format": "int32" }, "range": { "type": "string", "description": "Possible value range for this setting" }, "id": { "type": "string", "description": "Id of the setting definition", "format": "uuid" }, "helpUrl": { "type": "string", "description": "Help url for the setting definition" }, "userGroupSettingMode": { "enum": [ "None", "MaximumValue", "MinimumValue", "Manual", "FirstValue" ], "type": "string", "description": "UserGroupSettingMode for the setting definition" }, "categoryId": { "type": "string", "description": "Category Id for the setting definition", "format": "uuid" }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelNonResource" }, "description": "Collection of labels for the setting definition" }, "allowSystemSetting": { "type": "boolean", "description": "Indicates whether this setting can be configured at the system level." }, "allowUserSetting": { "type": "boolean", "description": "Indicates whether this setting can be configured per user." }, "roleRequiredForChange": { "type": "string", "description": "Role that needs to be changed" }, "name": { "type": "string", "description": "Name of the setting definition" }, "dataType": { "enum": [ "None", "Boolean", "Text", "Numeric", "DateTime", "Xml", "Role", "Reference", "EncryptedText", "DefSchema" ], "type": "string", "description": "Data type of this setting" }, "tag": { "type": "string", "description": "Tag for this setting containing extra information. Opt-in: returned only when requested. Include via a \"select-settingdefinition: Tag\" header." }, "modifiedOn": { "type": "string", "description": "Last modification datetime in UTC time.", "format": "date-time" }, "createdOn": { "type": "string", "description": "Creation datetime in UTC time.", "format": "date-time" }, "_links": { "type": "object", "properties": { "modifiedBy": { "description": "Relation to the user who last modified this settingdefinition.", "$ref": "#/components/schemas/Link" }, "createdBy": { "description": "Relation to the user who created this settingdefinition.", "$ref": "#/components/schemas/Link" }, "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "modifiedBy": { "description": "Relation to the user who last modified this settingdefinition. Embed via a \"select-numericsettingdefinition: modifiedBy\" header.", "$ref": "#/components/schemas/UserResource" }, "createdBy": { "description": "Relation to the user who created this settingdefinition. Embed via a \"select-numericsettingdefinition: createdBy\" header.", "$ref": "#/components/schemas/UserResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "Representation of a NumericSettingDefinition resource." }, "ObjectArrayParameterModel": { "title": "Object array parameter model", "oneOf": [ { "type": "array", "items": { "type": "string" } }, { "$ref": "#/components/schemas/ValueFieldModel" } ], "description": "Multi-value field content, provided either as a plain array of strings or as an add/remove update object." }, "ObjectChangedRuleConditionModel": { "title": "Object changed rule condition model", "type": "object", "properties": { "index": { "type": "integer", "description": "Index of the condition within the rule's condition collection", "format": "int32" }, "conditionType": { "description": "Type of condition to be evaluated.", "$ref": "#/components/schemas/RuleConditionDataType" } }, "description": "Model for ObjectChanged rule condition" }, "ObjectChangedRuleConditionNonResource": { "title": "Object changed rule condition non resource", "type": "object", "properties": { "index": { "type": "integer", "description": "Index of a rule condition in collection", "format": "int32" }, "conditionType": { "description": "Data type of this rule condition", "$ref": "#/components/schemas/RuleConditionDataType" } }, "description": "Representation of Object Changed rule condition" }, "ObjectCreatedOrChangedRuleConditionModel": { "title": "Object created or changed rule condition model", "type": "object", "properties": { "index": { "type": "integer", "description": "Index of the condition within the rule's condition collection", "format": "int32" }, "conditionType": { "description": "Type of condition to be evaluated.", "$ref": "#/components/schemas/RuleConditionDataType" } }, "description": "Model for ObjectCreatedOrChanged rule condition" }, "ObjectCreatedOrChangedRuleConditionNonResource": { "title": "Object created or changed rule condition non resource", "type": "object", "properties": { "index": { "type": "integer", "description": "Index of a rule condition in collection", "format": "int32" }, "conditionType": { "description": "Data type of this rule condition", "$ref": "#/components/schemas/RuleConditionDataType" } }, "description": "Representation of Object Created Or Changed rule condition" }, "ObjectCreatedRuleConditionModel": { "title": "Object created rule condition model", "type": "object", "properties": { "index": { "type": "integer", "description": "Index of the condition within the rule's condition collection", "format": "int32" }, "conditionType": { "description": "Type of condition to be evaluated.", "$ref": "#/components/schemas/RuleConditionDataType" } }, "description": "Model for ObjectCreated rule condition" }, "ObjectCreatedRuleConditionNonResource": { "title": "Object created rule condition non resource", "type": "object", "properties": { "index": { "type": "integer", "description": "Index of a rule condition in collection", "format": "int32" }, "conditionType": { "description": "Data type of this rule condition", "$ref": "#/components/schemas/RuleConditionDataType" } }, "description": "Representation of Object Created rule condition" }, "ObjectDeletedRuleConditionModel": { "title": "Object deleted rule condition model", "type": "object", "properties": { "index": { "type": "integer", "description": "Index of the condition within the rule's condition collection", "format": "int32" }, "conditionType": { "description": "Type of condition to be evaluated.", "$ref": "#/components/schemas/RuleConditionDataType" } }, "description": "Model for ObjectDeleted rule condition" }, "ObjectDeletedRuleConditionNonResource": { "title": "Object deleted rule condition non resource", "type": "object", "properties": { "index": { "type": "integer", "description": "Index of a rule condition in collection", "format": "int32" }, "conditionType": { "description": "Data type of this rule condition", "$ref": "#/components/schemas/RuleConditionDataType" } }, "description": "Representation of Object Deleted rule condition" }, "OnlyOnFirstVersionConditionModel": { "title": "Only on first version condition model", "type": "object", "properties": { "conditionType": { "description": "The type of condition. Determines which additional properties apply.", "$ref": "#/components/schemas/FileProcessConditionDataType" } }, "description": "Model for OnlyOnFirstVersion condition - checks if the file is on its first version This condition has no additional properties" }, "OptionListFieldDefinitionCreateCommand": { "title": "Option list field definition create command", "type": "object", "properties": { "acceptMultipleOptions": { "type": "boolean", "description": "When set to true, multiple options can be selected for this field." }, "items": { "description": "Options available for this field. Use Items.AddOrUpdate to add or update options, or Items.Remove to remove them.", "$ref": "#/components/schemas/OptionListItemCollectionModel" }, "sortOrder": { "type": "string", "description": "Sort order applied to the options of this field." }, "filter": { "type": "string", "description": "Filter expression applied to restrict the available options." }, "metadataPredictionEnabled": { "type": "boolean", "description": "When set to true, this field's value can be predicted using AI-based metadata prediction." }, "hints": { "type": "string", "description": "Hints used to guide AI-based metadata prediction for this field." }, "dataType": { "description": "Data type of the field definition. Determines which other properties apply.", "$ref": "#/components/schemas/FieldDefinitionType" }, "enabledLanguages": { "description": "Languages in which this field is enabled. Use AddOrUpdate to add or update members, or Remove to remove them.", "$ref": "#/components/schemas/EditableIdCollectionModel" }, "indexed": { "type": "boolean", "description": "When set to true, the field is indexed for search." }, "inlineStyle": { "type": "string", "description": "Inline CSS style applied to the field in the DAM UI." }, "isReadOnly": { "type": "boolean", "description": "When set to true, the field cannot be edited." }, "isRequired": { "type": "boolean", "description": "When set to true, the field is required." }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelModel" }, "description": "Multi-language labels for the name of this field." }, "languageMode": { "type": "string", "description": "Language mode of the field." }, "memberships": { "description": "Field groups this field is a member of. Use AddOrUpdate to add or update members, or Remove to remove them.", "$ref": "#/components/schemas/EditableIdCollectionModel" }, "name": { "type": "string", "description": "Name of the field." }, "scope": { "type": "string", "description": "Scope of the field." }, "sortIndex": { "type": "integer", "description": "Sort index used to order the field relative to other fields.", "format": "int32" }, "tag": { "type": "string", "description": "Tag associated with the field." }, "defaultValue": { "type": "string", "description": "Default value assigned to the field." }, "resetToDefaultTriggers": { "type": "array", "items": { "type": "string" }, "description": "Names of the triggers that reset the field to its default value." }, "resetToDefaultFields": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Ids of the fields that reset this field to its default value when they change." }, "validation": { "type": "string", "description": "Validation expression applied to the field value." }, "validationErrorMessage": { "type": "string", "description": "Error message shown when validation fails." }, "validationTrigger": { "type": "string", "description": "Trigger that determines when validation is applied." }, "storageMode": { "type": "string", "description": "Storage mode of the field." }, "helpTexts": { "type": "array", "items": { "$ref": "#/components/schemas/HelpTextModel" }, "description": "Multi-language help texts for this field." } }, "description": "Command to create an option list field definition." }, "OptionListFieldDefinitionResource": { "title": "Option list field definition resource", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/OptionListItemDefinitionNonResource" }, "description": "Options for this option list." }, "acceptMultipleOptions": { "type": "boolean", "description": "Indicates whether more than one option can be selected for this field." }, "sortOrder": { "enum": [ "Name", "SortIndex", "Label" ], "type": "string", "description": "How the options in this list are ordered when displayed (by name, sort index, or label)." }, "filter": { "type": "string", "description": "Filter of this field." }, "metadataPredictionEnabled": { "type": "boolean", "description": "Indicates whether the field can be predicted by the AI." }, "hints": { "type": "string", "description": "AI Prediction hint for this field." }, "label": { "type": "string", "description": "Label of this field." }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelNonResource" }, "description": "A collection of Label items." }, "dataType": { "$ref": "#/components/schemas/FieldDataType" }, "scope": { "enum": [ "RecordContentGlobal", "RecordContentClassDependent", "RecordContentFloating", "ClassificationProfileClassDependent", "UserGlobal", "FileFileTypeDependent", "FileFloating", "IndexerTaskGlobal", "FileGlobal", "ClassificationProfileFloating", "RecordContentContentTypeDependent" ], "type": "string", "description": "Scope." }, "scopeCategory": { "enum": [ "Record", "File", "Classification", "User", "IndexerTask", "MetadataTemplate" ], "type": "string", "description": "Scope category." }, "indexed": { "type": "boolean", "description": "Indicator if searching on this field is enabled." }, "languageMode": { "enum": [ "Single", "Multiple" ], "type": "string", "description": "Language mode of the field." }, "memberships": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Memberships of a field." }, "searchIndexRebuildRequired": { "type": "boolean", "description": "Indicator if a search index rebuild is required." }, "enabledLanguages": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Enabled languages." }, "id": { "type": "string", "description": "Identifier for this field.", "format": "uuid" }, "name": { "type": "string", "description": "Name for this field." }, "isRequired": { "type": "boolean", "description": "Indicates whether this field is required." }, "isReadOnly": { "type": "boolean", "description": "Indicates whether this field is read only." }, "isUniqueIdentifier": { "type": "boolean", "description": "Indicates whether this field is a unique identifier." }, "inlineStyle": { "type": "string", "description": "Inline CSS style applied to this field." }, "sortIndex": { "type": "integer", "description": "Sorting index of this field.", "format": "int32" }, "tag": { "type": "string", "description": "Tag for this field containing extra information. Opt-in: returned only when requested. Include via a \"select-fielddefinition: Tag\" header." }, "createdOn": { "type": "string", "description": "Created on the specified date in UTC time", "format": "date-time" }, "modifiedOn": { "type": "string", "description": "Modified on the specified date in UTC time", "format": "date-time" }, "defaultValue": { "type": "string", "description": "Default value of this field." }, "resetToDefaultTriggers": { "type": "array", "items": { "enum": [ "None", "OnNewField", "OnLoad", "OnSave", "OnAnyFileChange", "OnReclassifyRecord", "OnAnyChange", "OnFieldChange", "OnMasterFileChange", "OnCurrentFileChange", "OnFieldDefinitionChanged", "OnDuplicateRecord", "OnRecordStatusChange" ], "type": "string" }, "description": "'reset to default triggers' value of this field." }, "validation": { "type": "string", "description": "Validation of this field." }, "validationErrorMessage": { "type": "string", "description": "Error message of this field." }, "validationTrigger": { "enum": [ "None", "WhenNeeded", "Always" ], "type": "string", "description": "Trigger that determines when validation is evaluated for this field." }, "storageMode": { "enum": [ "None", "NonEmptyValues", "AllValues", "LogChanges" ], "type": "string", "description": "Storage mode of this field." }, "resetToDefaultFields": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Fields that trigger this field to be reset back to its default value. This is only used if \"ResetToDefaultTriggers\" is set to \"OnFieldChange\"." }, "helpText": { "type": "string", "description": "Help text of this field." }, "helpTexts": { "type": "array", "items": { "$ref": "#/components/schemas/HelpTextNonResource" }, "description": "A collection of HelpText items." }, "_links": { "type": "object", "properties": { "createdBy": { "description": "Relation to the user who created this field definition.", "$ref": "#/components/schemas/Link" }, "modifiedBy": { "description": "Relation to the user who last modified this field definition.", "$ref": "#/components/schemas/Link" }, "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "createdBy": { "description": "Relation to the user who created this field definition. Embed via a \"select-fielddefinition: createdBy\" header.", "$ref": "#/components/schemas/UserResource" }, "modifiedBy": { "description": "Relation to the user who last modified this field definition. Embed via a \"select-fielddefinition: modifiedBy\" header.", "$ref": "#/components/schemas/UserResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "Representation of the definition of an option list field" }, "OptionListFieldFacetModel": { "title": "Option list field facet model", "type": "object", "properties": { "maximumFacetValues": { "type": [ "null", "integer" ], "description": "Maximum number of facet values returned.", "format": "int32" }, "fieldId": { "type": [ "null", "string" ], "description": "The id of the field this facet should operate on.", "format": "uuid" }, "filters": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Filters allow you to limit the hits returned without affecting facets. If filters are specified, the aggregated counts in the facets remain the same. However, only records that match the filter criteria specified in the facet are returned. The parameter type of the filters depends on the facet type, but is always the same type as explicitValues/explicitRanges." }, "explicitValues": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "A list of values. When specified, only shows facets corresponding to the specified values. If not specified, all occurring values are included." }, "explicitRanges": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Allows for the explicit specification of ranges to include in the facet. If explicitRanges is specified, you cannot specify rangeStart, rangeEnd, or spans (on the concrete range facet type)." }, "name": { "type": "string", "description": "A textual identifier for this facet, used only by the client to correlate requests with responses." }, "type": { "enum": [ "NumericField", "NumericFieldRange", "Classification", "CreatedBy", "ModifiedBy", "FileType", "OptionListField", "TextField", "DateTimeFieldRange", "DateFieldRange", "CreatedOn", "ModifiedOn", "TimeFieldRange", "TextListField", "ContentType", "ClassificationListField", "DateFieldRangeFilter", "NumericFieldRangeFilter" ], "type": "string", "description": "Type of the facet. Depending on facet type, different parameters, combinations of parameters and parameter types are possible." } }, "description": "Facets on an OptionList-type field's selected options. explicitValues is a list of option ids." }, "OptionListFieldItemResource": { "title": "Option list field item resource", "type": "object", "properties": { "id": { "type": "string", "description": "The Id of the OptionListItemDefinition (represented as a GUID value).", "format": "uuid" }, "name": { "type": "string", "description": "The definition name." }, "label": { "type": "string", "description": "The definition label." }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelNonResource" }, "description": "A collection of Label items." }, "sortIndex": { "type": "integer", "description": "The definition sort index.", "format": "int32" }, "image": { "description": "The definition image.", "$ref": "#/components/schemas/ImageNonResource" }, "tag": { "type": "string", "description": "The definition tag. Opt-in: returned only when requested. Include via a \"select-fielddefinition: Tag\" header." }, "disabledInDAMUI": { "type": "boolean", "description": "Defines the state of the option in DAM UI. If it's disabled, it can't be selected in DAM UI." } }, "description": "The definition of the OptionListItem as possible filtered value for a OptionListField." }, "OptionListFieldResource": { "title": "Option list field resource", "type": "object", "properties": { "dataType": { "$ref": "#/components/schemas/FieldDataType" }, "fieldName": { "type": "string", "description": "Name of this field." }, "label": { "type": "string", "description": "Label of this field." }, "id": { "type": "string", "description": "Id of this field.", "format": "uuid" }, "localizedValues": { "type": "array", "items": { "$ref": "#/components/schemas/OptionListFieldValues" }, "description": "Language specific data of this field." }, "inheritanceState": { "enum": [ "None", "Inherited" ], "type": [ "null", "string" ], "description": "Inheritance State of this field. Opt-in: returned only when requested. Include via a \"select-field: InheritanceState\" header." }, "inheritable": { "type": [ "null", "boolean" ], "description": "Whether the field value can be used as a parent in inheritance hierarchy. Opt-in: returned only when requested. Include via a \"select-field: Inheritable\" header." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" }, "definition": { "description": "Relation to the field definition.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "definition": { "description": "Relation to the field definition. Embed via a \"select-optionlistfield: definition\" header.", "$ref": "#/components/schemas/FieldDefinitionResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "Representation of an option list field." }, "OptionListFieldValues": { "title": "Option list field values", "type": "object", "properties": { "values": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Language-specific collection of OptionListItem Ids (represented as GUID values)." }, "aIInfluenced": { "type": "boolean", "description": "Flag to indicate whether the value has come from AI." }, "languageId": { "type": "string", "description": "The language id.", "format": "uuid" }, "readOnly": { "type": [ "null", "boolean" ], "description": "Tells if the field is read-only." }, "modifiedOn": { "type": "string", "description": "Contains the date/time when the field is last modified.", "format": "date-time" } }, "description": "The collection of language-specific values stored in the OptionList field." }, "OptionListItemCollectionModel": { "title": "Option list item collection model", "type": "object", "properties": { "addOrUpdate": { "type": "array", "items": { "$ref": "#/components/schemas/OptionListItemModel" }, "description": "Options to add or update." }, "remove": { "type": "array", "items": { "$ref": "#/components/schemas/OptionListItemModel" }, "description": "Options to remove." } }, "description": "Options of an option list field definition." }, "OptionListItemDefinitionNonResource": { "title": "Option list item definition non resource", "type": "object", "properties": { "id": { "type": "string", "description": "The Id of the OptionListItemDefinition (represented as a GUID value).", "format": "uuid" }, "name": { "type": "string", "description": "The definition name." }, "label": { "type": "string", "description": "The definition label." }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelNonResource" }, "description": "A collection of Label items." }, "sortIndex": { "type": "integer", "description": "The definition sort index.", "format": "int32" }, "image": { "description": "The definition image.", "$ref": "#/components/schemas/ImageNonResource" }, "tag": { "type": "string", "description": "The definition tag. Opt-in: returned only when requested. Include via a \"select-fielddefinition: Tag\" header." }, "disabledInDAMUI": { "type": "boolean", "description": "Defines the state of the option in DAM UI. If it's disabled, it can't be selected in DAM UI." } }, "description": "The definition of the OptionListItem." }, "OptionListItemModel": { "title": "Option list item model", "type": "object", "properties": { "id": { "type": "string", "description": "Id of the option.", "format": "uuid" }, "name": { "type": "string", "description": "Name of the option." }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelModel" }, "description": "Multi-language labels for the name of this option." }, "tag": { "type": "string", "description": "Tag associated with the option." }, "disabledInDAMUI": { "type": "boolean", "description": "When set to true, the option is disabled in the DAM UI." } }, "description": "A single option of an option list field definition." }, "OrderCollectionResource": { "title": "Order collection resource", "type": "object", "properties": { "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of collection of orders. Retrieving this collection is currently not exposed via the REST API. The supported order types are download orders, email orders, FTP resort orders, and public CDN orders." }, "OrderDownloadLinkMassTargetResource": { "title": "Order download link mass target resource", "type": "object", "properties": { "recordIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs of the records that this target represents, in the case of a download order that was requested to be submitted without preliminary checks." }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/DownloadLinkMassOrderTargetError" }, "description": "Collection with recordIds for each target error." }, "recordId": { "type": "string", "description": "The Id of the Record this target represents.", "format": "uuid" }, "fileVersionId": { "type": [ "null", "string" ], "description": "The Id of the Record file version this target represents.", "format": "uuid" }, "errorDescription": { "type": "string", "description": "User friendly message in case of error." }, "targetType": { "description": "Type of the target", "$ref": "#/components/schemas/OrderTargetResourceAssetType" }, "id": { "type": "string", "description": "The Id of this target.", "format": "uuid" }, "status": { "description": "The status of this target.", "$ref": "#/components/schemas/MaintenanceTargetResourceStatus" }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of an order target with mass record ids for download link" }, "OrderDownloadLinkTargetResource": { "title": "Order download link target resource", "type": "object", "properties": { "recordId": { "type": "string", "description": "The Id of the Record this target represents.", "format": "uuid" }, "fileVersionId": { "type": [ "null", "string" ], "description": "The Id of the Record file version this target represents.", "format": "uuid" }, "errorDescription": { "type": "string", "description": "User friendly message in case of error." }, "targetType": { "description": "Type of the target", "$ref": "#/components/schemas/OrderTargetResourceAssetType" }, "id": { "type": "string", "description": "The Id of this target.", "format": "uuid" }, "status": { "description": "The status of this target.", "$ref": "#/components/schemas/MaintenanceTargetResourceStatus" }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of an order target of a download link" }, "OrderEditCommand": { "title": "Order edit command", "type": "object", "properties": { "status": { "description": "New lifecycle status of the order.", "$ref": "#/components/schemas/MaintenanceStatus" }, "deliveredFiles": { "type": "array", "items": { "type": "string" }, "description": "Files that were delivered for this order." } }, "description": "Payload for updating the status and delivered files of an existing order." }, "OrderPagedCollectionResource": { "title": "Order paged collection resource", "type": "object", "properties": { "pageNumber": { "type": [ "null", "integer" ], "description": "The current page of this paged collection.", "format": "int32" }, "pageSize": { "type": [ "null", "integer" ], "description": "The current page size of this paged collection.", "format": "int32" }, "skip": { "type": [ "null", "integer" ], "description": "The current skip size of this paged collection.", "format": "int32" }, "take": { "type": [ "null", "integer" ], "description": "The current take size of this paged collection.", "format": "int32" }, "totalCount": { "type": "integer", "description": "The total count of items in this paged collection, not just on the current page.", "format": "int64" }, "items": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/AkamaiCdnOrderResource" }, { "$ref": "#/components/schemas/BrandTemplateOrderResource" }, { "$ref": "#/components/schemas/BrandTemplatePreprocessingOrderResource" }, { "$ref": "#/components/schemas/DownloadOrderResource" }, { "$ref": "#/components/schemas/EmailOrderResource" }, { "$ref": "#/components/schemas/FtpOrderResource" }, { "$ref": "#/components/schemas/FtpResortOrderResource" }, { "$ref": "#/components/schemas/PublicCdnOrderResource" }, { "$ref": "#/components/schemas/ShareDownloadLinkOrderResource" }, { "$ref": "#/components/schemas/DownloadContactSheetResource" } ], "discriminator": { "propertyName": "orderType", "mapping": { "akamaiCdn": "#/components/schemas/AkamaiCdnOrderResource", "brandTemplate": "#/components/schemas/BrandTemplateOrderResource", "brandTemplatePreprocessing": "#/components/schemas/BrandTemplatePreprocessingOrderResource", "download": "#/components/schemas/DownloadOrderResource", "email": "#/components/schemas/EmailOrderResource", "ftp": "#/components/schemas/FtpOrderResource", "ftpResort": "#/components/schemas/FtpResortOrderResource", "publicCdn": "#/components/schemas/PublicCdnOrderResource", "shareDownloadLink": "#/components/schemas/ShareDownloadLinkOrderResource", "contactsheet": "#/components/schemas/DownloadContactSheetResource" } } }, "description": "One page of this paged collection, which is a subcollection of the complete collection." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" }, "first": { "description": "A link to the first page of this paged collection.", "$ref": "#/components/schemas/Link" }, "prev": { "description": "A link to the previous page of this paged collection.", "$ref": "#/components/schemas/Link" }, "next": { "description": "A link to the next page of this paged collection.", "$ref": "#/components/schemas/Link" }, "last": { "description": "A link to the last page of this paged collection.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of a paged collection of orders" }, "OrderTargetActionNonResource": { "title": "Order target action non resource", "type": "object", "properties": { "label": { "type": "string", "description": "Short description of the action" } }, "description": "Representation of an action that can be applied on an order target" }, "OrderTargetCollectionResource": { "title": "Order target collection resource", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/OrderTargetResource" }, "description": "A collection of resource items." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "A collection of order targets" }, "OrderTargetModel": { "title": "Order target model", "type": "object", "properties": { "recordId": { "type": "string", "description": "Id of the record to include in the order. Mutually exclusive with RecordIds; specify exactly one of the two.", "format": "uuid" }, "recordIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Ids of the records to include in a download order, as a faster alternative to RecordId that skips preloading each record when the order is created (they're only loaded when the order executes, so an invalid or inaccessible id fails or partially fails at that point instead of at creation time). Only valid for download orders; when used, TargetTypes is restricted to Document, AdditionalFiles and/or Renditions, and AssetType must be LatestVersionOfMasterFile. Mutually exclusive with RecordId." }, "fileVersionId": { "type": [ "null", "string" ], "description": "Id of the specific file version to include in the order.", "format": "uuid" }, "additionalFileId": { "type": [ "null", "string" ], "description": "Id of the specific additional file to include in the order.", "format": "uuid" }, "renditionId": { "type": [ "null", "string" ], "description": "Id of the specific rendition to include in the order.", "format": "uuid" }, "assetType": { "description": "Which version(s) of the record's file(s) to include in the order.", "$ref": "#/components/schemas/RecordAssetType" }, "targetTypes": { "type": "array", "items": { "$ref": "#/components/schemas/RecordTargetType" }, "description": "Which file types (document, thumbnail, preview, etc.) to include in the order." }, "actions": { "type": "array", "items": { "$ref": "#/components/schemas/ActionModel" }, "description": "Maintenance actions to run for this target." }, "filter": { "description": "Filter used to narrow down which files of the target record(s) are included in the order.", "$ref": "#/components/schemas/OrderTargetModelFilter" }, "forceRetry": { "type": "boolean", "description": "When set to true, forces this target to be retried even if it previously failed." }, "tag": { "type": "string", "description": "Free-form tag that can be used to identify or group this target." } }, "description": "A single record and the files/renditions of that record to include in an order." }, "OrderTargetModelFilter": { "title": "Order target model filter", "type": "object", "properties": { "extensions": { "type": "array", "items": { "type": "string" }, "description": "File extensions to include." }, "fileName": { "type": "string", "description": "File name to match." }, "metadata": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Metadata field values that files must match. Only applies to additional files." }, "purposes": { "type": "array", "items": { "type": "string" }, "description": "Purposes that files must match. Only applies to additional files." }, "presetNames": { "type": "array", "items": { "type": "string" }, "description": "Names of the presets that files must match." } }, "description": "Criteria used to narrow down which files of an order target are included." }, "OrderTargetResource": { "title": "Order target resource", "type": "object", "properties": { "recordId": { "type": "string", "description": "The Id of the Record this target represents.", "format": "uuid" }, "itemId": { "type": "string", "description": "The Id of the object (Version, Preview, Thumbnail, Custom, AdditionalFile) this target represents.", "format": "uuid" }, "recordIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Record ids for mass target." }, "type": { "description": "The asset type of this target.", "$ref": "#/components/schemas/OrderTargetResourceAssetType" }, "fileName": { "type": "string", "description": "The filename of the delivered file." }, "actions": { "type": "array", "items": { "$ref": "#/components/schemas/OrderTargetActionNonResource" }, "description": "The actions that are executed on the ordered file." }, "id": { "type": "string", "description": "The Id of this target.", "format": "uuid" }, "attempt": { "type": "integer", "description": "Value indicating how many times the maintenance manager has already tried to execute this target.", "format": "int32" }, "errorDetails": { "type": "string", "description": "Detailed information about the error that occurred if this target failed to execute successfully." }, "executionTime": { "type": "string", "description": "The amount of time needed to execute this target" }, "forceRetry": { "type": "boolean", "description": "Value indicating whether or not a new maintenance job will be created to retry this target after it finished its execution." }, "message": { "type": "string", "description": "The message that was set during the execution of this target" }, "status": { "description": "The status of this target.", "$ref": "#/components/schemas/MaintenanceTargetResourceStatus" }, "tag": { "type": "string", "description": "Custom data associated with this target, if any." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of an order target" }, "OrderTargetResourceAssetType": { "title": "Order target resource asset type", "enum": [ "Version", "Preview", "Thumbnail", "Custom", "AdditionalFile", "Rendition" ], "type": "string" }, "OrdersFtpConnectionType": { "title": "Orders ftp connection type", "enum": [ "Normal", "ImplicitEncryption", "ExplicitSSLEncryption", "ExplicitTLSEncryption" ], "type": "string", "x-enum-descriptions": [ "Plain, unencrypted FTP connection.", "FTP over an implicitly encrypted (FTPS) connection.", "FTP with explicit SSL encryption negotiated after connecting.", "FTP with explicit TLS encryption negotiated after connecting." ] }, "OriginalRenditionResource": { "title": "Original rendition resource", "type": "object", "properties": { "id": { "type": "string", "description": "Identifier for the rendition", "format": "uuid" }, "uri": { "type": "string", "description": "Uri for this rendition Opt-in: returned only when requested. Include via a \"select-rendition: Uri\" header." }, "type": { "enum": [ "Original", "Preset", "Crop", "Trim", "Custom" ], "type": "string", "description": "Rendition type" }, "name": { "type": "string", "description": "Rendition name" }, "extension": { "type": "string", "description": "The extension of the rendition" }, "preview": { "type": "string", "description": "The preview of the rendition Opt-in: returned only when requested. Include via a \"select-rendition: Preview\" header." }, "publishedUri": { "type": "string", "description": "Shortcut property to the URI of the published public link of the rendition Opt-in: returned only when requested. Include via a \"select-rendition: PublishedUri\" header." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" }, "publicLinks": { "description": "Relation to the rendition public links.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "publicLinks": { "description": "Relation to the rendition public links. Embed via a \"select-rendition: publicLinks\" header.", "$ref": "#/components/schemas/PublicLinkCollectionResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "Representation of a rendition" }, "OverwriteFieldActionParametersModel": { "title": "Overwrite field action parameters model", "type": "object", "properties": { "fieldId": { "type": "string", "description": "Id of the field to overwrite.", "format": "uuid" }, "value": { "description": "New value for the field. The real shape depends on the target field's own data type, looked up server-side, not anything in this payload: a JSON string for Text/DateTime/Time/Duration-typed fields, a JSON number or string for Numeric-typed fields, or a JSON array of strings for list-typed fields (OptionList/UserList/ UserGroupList/ClassificationList/RecordList/LanguageList/TextList)." }, "languageId": { "type": "string", "description": "Language of the field value, for multilingual fields.", "format": "uuid" }, "useReferences": { "type": "boolean", "description": "When set, resolves the value as a reference (e.g. a classification path) instead of a literal." } }, "description": "Parameters for the \"OverwriteField\" maintenance job action." }, "PermissionCollectionModel": { "title": "Permission collection model", "type": "object", "properties": { "addOrUpdate": { "type": "array", "items": { "$ref": "#/components/schemas/UsersPermissionModel" }, "description": "The permissions to add or update." }, "remove": { "type": "array", "items": { "$ref": "#/components/schemas/UsersPermissionModel" }, "description": "The permissions to remove." } }, "description": "A set of permission changes to apply, expressed as additions/updates and removals." }, "PermissionCollectionResource": { "title": "Permission collection resource", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PermissionResource" }, "description": "A collection of resource items." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of a non-paged collection of permissions" }, "PermissionEditCommand": { "title": "Permission edit command", "type": "object", "properties": { "originalName": { "type": "string", "description": "Current name of the permission to edit." }, "name": { "type": "string", "description": "Name of the permission." }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelModel" }, "description": "Multi-language labels for the name of this permission." } }, "description": "Edits an existing permission." }, "PermissionFilterModel": { "title": "Permission filter model", "type": "object", "properties": { "names": { "type": "array", "items": { "type": "string" }, "description": "Names of the calculated permissions to filter by." } }, "description": "Model used to filter calculated permissions by name." }, "PermissionModel": { "title": "Permission model", "type": "object", "properties": { "userGroupId": { "type": [ "null", "string" ], "description": "Identifier of the user group this permission applies to.", "format": "uuid" }, "accessRight": { "enum": [ "NoAccess", "Read", "Classify", "Modify", "Delete", "FullControl", "DeleteDenyFullControl", "ModifyDenyDelete", "ClassifyDenyModify", "ReadDenyClassify", "DenyRead", "Inherit" ], "type": [ "null", "string" ], "description": "Access right granted to the user group." }, "id": { "type": "string", "description": "Identifier used to match this entry, equal to UserGroupId.", "format": "uuid" } }, "description": "Permission granted to a user group on a classification." }, "PermissionPagedCollectionResource": { "title": "Permission paged collection resource", "type": "object", "properties": { "pageNumber": { "type": [ "null", "integer" ], "description": "The current page of this paged collection.", "format": "int32" }, "pageSize": { "type": [ "null", "integer" ], "description": "The current page size of this paged collection.", "format": "int32" }, "skip": { "type": [ "null", "integer" ], "description": "The current skip size of this paged collection.", "format": "int32" }, "take": { "type": [ "null", "integer" ], "description": "The current take size of this paged collection.", "format": "int32" }, "totalCount": { "type": "integer", "description": "The total count of items in this paged collection, not just on the current page.", "format": "int64" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/PermissionResource" }, "description": "One page of this paged collection, which is a subcollection of the complete collection." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" }, "first": { "description": "A link to the first page of this paged collection.", "$ref": "#/components/schemas/Link" }, "prev": { "description": "A link to the previous page of this paged collection.", "$ref": "#/components/schemas/Link" }, "next": { "description": "A link to the next page of this paged collection.", "$ref": "#/components/schemas/Link" }, "last": { "description": "A link to the last page of this paged collection.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of a paged collection of permissions" }, "PermissionResource": { "title": "Permission resource", "type": "object", "properties": { "name": { "type": "string", "description": "Name of this permission." }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelNonResource" }, "description": "A collection of Label items." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "A right that can be granted to a user or user group (e.g. read, write, delete) on a record, classification, or collection - this resource is the catalog entry describing the right itself, not a specific grant of it." }, "PermissionValueCollectionResource": { "title": "Permission value collection resource", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PermissionValueResource" }, "description": "A collection of resource items." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of a non-paged collection of permission values" }, "PermissionValueResource": { "title": "Permission value resource", "type": "object", "properties": { "name": { "type": "string", "description": "Name of this permission." }, "value": { "enum": [ "None", "Granted", "Denied" ], "type": "string", "description": "Value of this permission." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of the definition of a PermissionValue" }, "PermissionsModel": { "title": "Permissions model", "type": "object", "properties": { "addOrUpdate": { "type": "array", "items": { "$ref": "#/components/schemas/PermissionModel" }, "description": "Permissions to add or update." }, "remove": { "type": "array", "items": { "$ref": "#/components/schemas/PermissionModel" }, "description": "Permissions to remove." } }, "description": "Collection of permissions to add, update, or remove." }, "PhraseSuggestionRequestModel": { "title": "Phrase suggestion request model", "type": "object", "properties": { "text": { "type": "string", "description": "Input text to generate phrase suggestions for." }, "maxSuggestions": { "type": [ "null", "integer" ], "description": "Maximum number of phrase suggestions to return.", "format": "int32" }, "languageIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Identifiers of the languages to search within." } }, "description": "Represents a request for phrase-level search suggestions." }, "PhraseSuggestionsNonResource": { "title": "Phrase suggestions non resource", "type": "object", "properties": { "suggestions": { "type": "array", "items": { "type": "string" }, "description": "Suggested phrases." } }, "description": "A reply to a phrase-level search suggestion request." }, "PredictiveMetadataActionParametersModel": { "title": "Predictive metadata action parameters model", "type": "object", "description": "Parameters for the \"PredictiveMetadata\" maintenance job action. This action takes no parameters." }, "PredictiveMetadataRuleActionModel": { "title": "Predictive metadata rule action model", "type": "object", "properties": { "index": { "type": "integer", "description": "Index of the action within the rule's action collection", "format": "int32" }, "actionType": { "description": "Type of action to be executed.", "$ref": "#/components/schemas/RuleActionDataType" }, "executionTime": { "description": "When the action should be executed.", "$ref": "#/components/schemas/RuleExecutionTime" } }, "description": "Model for PredictiveMetadata rule action" }, "PredictiveMetadataRuleActionNonResource": { "title": "Predictive metadata rule action non resource", "type": "object", "properties": { "index": { "type": "integer", "description": "Index of a rule action in collection", "format": "int32" }, "actionType": { "description": "Data type of this rule action", "$ref": "#/components/schemas/RuleActionDataType" }, "executionTime": { "description": "Execution time of the rule action", "$ref": "#/components/schemas/RuleExecutionTime" } }, "description": "Representation of predictive metadata rule action" }, "PrepareRecordCheckInCommand": { "title": "Prepare record check in command", "type": "object", "properties": { "uploadServiceUrl": { "type": "string", "description": "URL of the upload service that will host the new file version." }, "fileName": { "type": "string", "description": "Name of the file being checked in." }, "versionLabel": { "type": "string", "description": "When set, the version label to apply to the new file version." }, "comment": { "type": "string", "description": "When set, the comment to associate with the new file version." }, "previews": { "type": "array", "items": { "$ref": "#/components/schemas/UploadPreviewModel" }, "description": "When set, the previews to generate for the new file version." }, "publicationItems": { "type": "array", "items": { "$ref": "#/components/schemas/PublicationItemModel" }, "description": "When set, the publication items to associate with the new file version." }, "authorizationHeader": { "type": "string", "description": "When set, the authorization header to use when uploading to UploadServiceUrl." }, "record": { "type": "string", "description": "Record being checked in." } }, "description": "Prepares a check-in for a record by requesting an upload location and registering the previews and publication items to expect." }, "PresetRenditionResource": { "title": "Preset rendition resource", "type": "object", "properties": { "width": { "type": "integer", "description": "The width of the preset rendition", "format": "int32" }, "height": { "type": "integer", "description": "The height of the preset rendition", "format": "int32" }, "presetHash": { "type": "string", "description": "The hash of the preset rendition" }, "crc32": { "type": "integer", "description": "The calculated crc32 of the preset rendition", "format": "int32" }, "id": { "type": "string", "description": "Identifier for the rendition", "format": "uuid" }, "uri": { "type": "string", "description": "Uri for this rendition Opt-in: returned only when requested. Include via a \"select-rendition: Uri\" header." }, "type": { "enum": [ "Original", "Preset", "Crop", "Trim", "Custom" ], "type": "string", "description": "Rendition type" }, "name": { "type": "string", "description": "Rendition name" }, "extension": { "type": "string", "description": "The extension of the rendition" }, "preview": { "type": "string", "description": "The preview of the rendition Opt-in: returned only when requested. Include via a \"select-rendition: Preview\" header." }, "publishedUri": { "type": "string", "description": "Shortcut property to the URI of the published public link of the rendition Opt-in: returned only when requested. Include via a \"select-rendition: PublishedUri\" header." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" }, "publicLinks": { "description": "Relation to the rendition public links.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "publicLinks": { "description": "Relation to the rendition public links. Embed via a \"select-rendition: publicLinks\" header.", "$ref": "#/components/schemas/PublicLinkCollectionResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "Representation of a rendition" }, "PublicBrandPortalDownloadOrderResource": { "title": "Public brand portal download order resource", "type": "object", "properties": { "orderType": { "type": "string", "description": "Type of the order" }, "deliveredFiles": { "type": "array", "items": { "type": "string" }, "description": "The files delivered to the client by this order." }, "totalFileSize": { "type": "integer", "description": "Total file size of the delivered files", "format": "int64" }, "creatorEmail": { "type": "string", "description": "E-mail address for this job" }, "disableNotification": { "type": "boolean", "description": "Value indicating whether or not notification is enabled on this job" }, "earliestStartDate": { "type": [ "null", "string" ], "description": "The earliest date in utc time on which this job can be executed.", "format": "date-time" }, "executionTime": { "type": "string", "description": "Time it took for this maintenance job to execute." }, "id": { "type": "string", "description": "Id of this maintenance job.", "format": "uuid" }, "type": { "type": "string", "description": "Name of this maintenance job." }, "priority": { "enum": [ "High", "Medium", "AuditArchiving", "BuildSearchIndex" ], "type": "string", "description": "Priority of this maintenance job." }, "startedOn": { "type": [ "null", "string" ], "description": "Time on which the execution of this maintenance job started in utc time.", "format": "date-time" }, "status": { "enum": [ "Pending", "Success", "Failed", "PartiallyFailed", "Executing", "Cancelled", "Scheduled", "Queued", "AsyncPending", "AsyncExecuting" ], "type": "string", "description": "Status of this maintenance job." }, "message": { "type": [ "null", "string" ], "description": "Error message that describes why this maintenance job failed. Returns null if this maintenance job hasn't been executed yet." }, "failedTargetsCount": { "type": "integer", "description": "Count of the failed targets.", "format": "int32" }, "createdOn": { "type": "string", "description": "Creation datetime in UTC time.", "format": "date-time" }, "_links": { "type": "object", "properties": { "targets": { "description": "Relation to a collection of order targets.", "$ref": "#/components/schemas/Link" }, "createdBy": { "description": "Relation to the user who created this maintenance job.", "$ref": "#/components/schemas/Link" }, "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "targets": { "description": "Relation to a collection of order targets. Embed via a \"select-order: targets\" header.", "$ref": "#/components/schemas/OrderTargetCollectionResource" }, "createdBy": { "description": "Relation to the user who created this maintenance job. Embed via a \"select-publicbrandportaldownloadorder: createdBy\" header.", "$ref": "#/components/schemas/UserResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "Representation of a public brand portal download order." }, "PublicCdnAdaptiveStreamingOrderCreateCommand": { "title": "Public cdn adaptive streaming order create command", "type": "object", "properties": { "targets": { "type": "array", "items": { "$ref": "#/components/schemas/PublicCdnOrderTargetModel" }, "description": "Records and renditions to publish to the Public CDN using adaptive streaming." }, "deliveryLocation": { "type": "string", "description": "Location where the order output is delivered." }, "includeTargets": { "type": "boolean", "description": "When set, includes the resolved order targets in the response." }, "disableProcessing": { "type": "string", "description": "When set, disables further processing of the order." }, "creatorEmail": { "type": "string", "description": "Email address of the user the job is created on behalf of." }, "disableNotification": { "type": "boolean", "description": "When set to true, suppresses notifications for this job." }, "earliestStartDate": { "type": [ "null", "string" ], "description": "Earliest date and time at which the job is allowed to start executing.", "format": "date-time" }, "priority": { "enum": [ "High", "Medium" ], "type": "string", "description": "Priority used to schedule this job relative to other maintenance jobs." }, "type": { "enum": [ "Classification", "Record", "ExportAuditTrail", "BulkRecord", "AcceptDownloadOrderAgreement", "BulkCollection", "ExportContentItemsList" ], "type": "string", "description": "Type of maintenance job to create." }, "actions": { "type": "array", "items": { "$ref": "#/components/schemas/ActionModel" }, "description": "Actions to execute for each target of this job." }, "title": { "type": "string", "description": "Title of the job. For a download or contact-sheet order this is shown on the Downloads page in Content Workspace; if omitted, it defaults to the file name, or \"X items\" when multiple files were ordered. Either plain text, or a JSON string of the form {\"studioName\":\"...\",\"moduleName\":\"...\",\"translationKey\":\"...\"} to look up a translated value for non-English users (see the Localization > Translations section of the DAM Administrator Guide for how translations are registered)." }, "description": { "type": "string", "description": "Description of the job. For a download or contact-sheet order this is shown on the Downloads page in Content Workspace; if omitted, it defaults to \"Download\". Accepts the same plain-text-or-translation-key JSON format as Title." }, "errorMode": { "type": "string", "description": "Determines how the job behaves when one of its targets fails to execute." } }, "description": "Payload for creating an order that publishes records to the Public CDN using adaptive streaming." }, "PublicCdnAdaptiveStreamingOrderResource": { "title": "Public cdn adaptive streaming order resource", "type": "object", "properties": { "deliveredFiles": { "type": "array", "items": { "$ref": "#/components/schemas/DeliveredFileWithAdditionalParameters" }, "description": "Collection of delivered files with related target properties." }, "orderType": { "type": "string", "description": "Type of the order" }, "totalFileSize": { "type": "integer", "description": "Total file size of the delivered files", "format": "int64" }, "creatorEmail": { "type": "string", "description": "E-mail address for this job" }, "disableNotification": { "type": "boolean", "description": "Value indicating whether or not notification is enabled on this job" }, "earliestStartDate": { "type": [ "null", "string" ], "description": "The earliest date in utc time on which this job can be executed.", "format": "date-time" }, "executionTime": { "type": "string", "description": "Time it took for this maintenance job to execute." }, "id": { "type": "string", "description": "Id of this maintenance job.", "format": "uuid" }, "type": { "type": "string", "description": "Name of this maintenance job." }, "priority": { "enum": [ "High", "Medium", "AuditArchiving", "BuildSearchIndex" ], "type": "string", "description": "Priority of this maintenance job." }, "startedOn": { "type": [ "null", "string" ], "description": "Time on which the execution of this maintenance job started in utc time.", "format": "date-time" }, "status": { "enum": [ "Pending", "Success", "Failed", "PartiallyFailed", "Executing", "Cancelled", "Scheduled", "Queued", "AsyncPending", "AsyncExecuting" ], "type": "string", "description": "Status of this maintenance job." }, "message": { "type": [ "null", "string" ], "description": "Error message that describes why this maintenance job failed. Returns null if this maintenance job hasn't been executed yet." }, "failedTargetsCount": { "type": "integer", "description": "Count of the failed targets.", "format": "int32" }, "createdOn": { "type": "string", "description": "Creation datetime in UTC time.", "format": "date-time" }, "_links": { "type": "object", "properties": { "targets": { "description": "Relation to a collection of order targets.", "$ref": "#/components/schemas/Link" }, "createdBy": { "description": "Relation to the user who created this maintenance job.", "$ref": "#/components/schemas/Link" }, "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "targets": { "description": "Relation to a collection of order targets. Embed via a \"select-order: targets\" header.", "$ref": "#/components/schemas/OrderTargetCollectionResource" }, "createdBy": { "description": "Relation to the user who created this maintenance job. Embed via a \"select-publiccdnadaptivestreamingorder: createdBy\" header.", "$ref": "#/components/schemas/UserResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "Representation of a public CDN adaptive streaming order." }, "PublicCdnOrderCreateCommand": { "title": "Public cdn order create command", "type": "object", "properties": { "targets": { "type": "array", "items": { "$ref": "#/components/schemas/PublicCdnOrderTargetModel" }, "description": "Records and renditions to publish to the Public CDN." }, "deliveryLocation": { "type": "string", "description": "Location where the order output is delivered." }, "includeTargets": { "type": "boolean", "description": "When set, includes the resolved order targets in the response." }, "disableProcessing": { "type": "string", "description": "When set, disables further processing of the order." }, "creatorEmail": { "type": "string", "description": "Email address of the user the job is created on behalf of." }, "disableNotification": { "type": "boolean", "description": "When set to true, suppresses notifications for this job." }, "earliestStartDate": { "type": [ "null", "string" ], "description": "Earliest date and time at which the job is allowed to start executing.", "format": "date-time" }, "priority": { "enum": [ "High", "Medium" ], "type": "string", "description": "Priority used to schedule this job relative to other maintenance jobs." }, "type": { "enum": [ "Classification", "Record", "ExportAuditTrail", "BulkRecord", "AcceptDownloadOrderAgreement", "BulkCollection", "ExportContentItemsList" ], "type": "string", "description": "Type of maintenance job to create." }, "actions": { "type": "array", "items": { "$ref": "#/components/schemas/ActionModel" }, "description": "Actions to execute for each target of this job." }, "title": { "type": "string", "description": "Title of the job. For a download or contact-sheet order this is shown on the Downloads page in Content Workspace; if omitted, it defaults to the file name, or \"X items\" when multiple files were ordered. Either plain text, or a JSON string of the form {\"studioName\":\"...\",\"moduleName\":\"...\",\"translationKey\":\"...\"} to look up a translated value for non-English users (see the Localization > Translations section of the DAM Administrator Guide for how translations are registered)." }, "description": { "type": "string", "description": "Description of the job. For a download or contact-sheet order this is shown on the Downloads page in Content Workspace; if omitted, it defaults to \"Download\". Accepts the same plain-text-or-translation-key JSON format as Title." }, "errorMode": { "type": "string", "description": "Determines how the job behaves when one of its targets fails to execute." } }, "description": "Payload for creating an order that publishes records to the Public CDN." }, "PublicCdnOrderResource": { "title": "Public cdn order resource", "type": "object", "properties": { "deliveredFiles": { "type": "array", "items": { "$ref": "#/components/schemas/DeliveredFileWithAdditionalParameters" }, "description": "Collection of delivered files with related target properties." }, "orderType": { "type": "string", "description": "Type of the order" }, "totalFileSize": { "type": "integer", "description": "Total file size of the delivered files", "format": "int64" }, "creatorEmail": { "type": "string", "description": "E-mail address for this job" }, "disableNotification": { "type": "boolean", "description": "Value indicating whether or not notification is enabled on this job" }, "earliestStartDate": { "type": [ "null", "string" ], "description": "The earliest date in utc time on which this job can be executed.", "format": "date-time" }, "executionTime": { "type": "string", "description": "Time it took for this maintenance job to execute." }, "id": { "type": "string", "description": "Id of this maintenance job.", "format": "uuid" }, "type": { "type": "string", "description": "Name of this maintenance job." }, "priority": { "enum": [ "High", "Medium", "AuditArchiving", "BuildSearchIndex" ], "type": "string", "description": "Priority of this maintenance job." }, "startedOn": { "type": [ "null", "string" ], "description": "Time on which the execution of this maintenance job started in utc time.", "format": "date-time" }, "status": { "enum": [ "Pending", "Success", "Failed", "PartiallyFailed", "Executing", "Cancelled", "Scheduled", "Queued", "AsyncPending", "AsyncExecuting" ], "type": "string", "description": "Status of this maintenance job." }, "message": { "type": [ "null", "string" ], "description": "Error message that describes why this maintenance job failed. Returns null if this maintenance job hasn't been executed yet." }, "failedTargetsCount": { "type": "integer", "description": "Count of the failed targets.", "format": "int32" }, "createdOn": { "type": "string", "description": "Creation datetime in UTC time.", "format": "date-time" }, "_links": { "type": "object", "properties": { "targets": { "description": "Relation to a collection of order targets.", "$ref": "#/components/schemas/Link" }, "createdBy": { "description": "Relation to the user who created this maintenance job.", "$ref": "#/components/schemas/Link" }, "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "targets": { "description": "Relation to a collection of order targets. Embed via a \"select-order: targets\" header.", "$ref": "#/components/schemas/OrderTargetCollectionResource" }, "createdBy": { "description": "Relation to the user who created this maintenance job. Embed via a \"select-publiccdnorder: createdBy\" header.", "$ref": "#/components/schemas/UserResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "Representation of a public cdn order." }, "PublicCdnOrderTargetModel": { "title": "Public cdn order target model", "type": "object", "properties": { "renditionName": { "type": "string", "description": "When creating a public link for a transformation of an original file (e.g. via a resizeImage action), this names the resulting \"external\" additional file the public link points to; the same value is available as the @RENDITIONNAME variable in .orderPublicLinkNamingConvention. Ignored if AdditionalFileId is set: to base the public link on a rendition that already exists (created from a .renditionPresets entry), pass its id via AdditionalFileId instead." }, "recordId": { "type": "string", "description": "Id of the record to include in the order. Mutually exclusive with RecordIds; specify exactly one of the two.", "format": "uuid" }, "recordIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Ids of the records to include in a download order, as a faster alternative to RecordId that skips preloading each record when the order is created (they're only loaded when the order executes, so an invalid or inaccessible id fails or partially fails at that point instead of at creation time). Only valid for download orders; when used, TargetTypes is restricted to Document, AdditionalFiles and/or Renditions, and AssetType must be LatestVersionOfMasterFile. Mutually exclusive with RecordId." }, "fileVersionId": { "type": [ "null", "string" ], "description": "Id of the specific file version to include in the order.", "format": "uuid" }, "additionalFileId": { "type": [ "null", "string" ], "description": "Id of the specific additional file to include in the order.", "format": "uuid" }, "renditionId": { "type": [ "null", "string" ], "description": "Id of the specific rendition to include in the order.", "format": "uuid" }, "assetType": { "description": "Which version(s) of the record's file(s) to include in the order.", "$ref": "#/components/schemas/RecordAssetType" }, "targetTypes": { "type": "array", "items": { "$ref": "#/components/schemas/RecordTargetType" }, "description": "Which file types (document, thumbnail, preview, etc.) to include in the order." }, "actions": { "type": "array", "items": { "$ref": "#/components/schemas/ActionModel" }, "description": "Maintenance actions to run for this target." }, "filter": { "description": "Filter used to narrow down which files of the target record(s) are included in the order.", "$ref": "#/components/schemas/OrderTargetModelFilter" }, "forceRetry": { "type": "boolean", "description": "When set to true, forces this target to be retried even if it previously failed." }, "tag": { "type": "string", "description": "Free-form tag that can be used to identify or group this target." } }, "description": "Order target for a Public CDN order, identifying the record and rendition to publish." }, "PublicLinkCollectionResource": { "title": "Public link collection resource", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PublicLinkResource" }, "description": "A collection of resource items." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of a non-paged collection of public links" }, "PublicLinkCreateCommand": { "title": "Public link create command", "type": "object", "properties": { "recordId": { "type": "string", "description": "Id of the record to create the public link for.", "format": "uuid" }, "fileVersionId": { "type": [ "null", "string" ], "description": "Id of the specific file version to create the public link for.", "format": "uuid" }, "additionalFileId": { "type": [ "null", "string" ], "description": "Id of the additional file to create the public link for.", "format": "uuid" }, "fileSize": { "type": [ "null", "integer" ], "description": "Size, in bytes, of the file the public link points to.", "format": "int64" }, "renditionName": { "type": "string", "description": "Name of the rendition the public link points to." }, "uri": { "type": "string", "description": "Storage URI of the file the public link points to." }, "provider": { "type": "string", "description": "Storage provider that hosts the file the public link points to." } }, "description": "Creates a public link for a record, optionally for a specific file version or additional file." }, "PublicLinkEditCommand": { "title": "Public link edit command", "type": "object", "properties": { "fileSize": { "type": [ "null", "integer" ], "description": "Size, in bytes, of the file the public link points to.", "format": "int64" }, "renditionName": { "type": "string", "description": "Name of the rendition the public link points to." }, "uri": { "type": "string", "description": "Storage URI of the file the public link points to." }, "provider": { "type": "string", "description": "Storage provider that hosts the file the public link points to." } }, "description": "Edits an existing public link." }, "PublicLinkPresetParametersModel": { "title": "Public link preset parameters model", "type": "object", "properties": { "presetName": { "type": "string", "description": "Name of the preset (required for Crop/Rendition preset types)." }, "presetType": { "description": "Kind of preset.", "$ref": "#/components/schemas/PublicLinkPresetType" } }, "description": "One public link preset entry, used by the \"CreatePublicLinks\"/\"DeletePublicLinks\" maintenance job actions." }, "PublicLinkPresetType": { "title": "Public link preset type", "enum": [ "OriginalFile", "Crop", "Rendition", "All", "AdaptiveStreaming" ], "type": "string" }, "PublicLinkResource": { "title": "Public link resource", "type": "object", "properties": { "uri": { "type": "string", "description": "Get the uri for published file" }, "status": { "enum": [ "Pending", "Published", "Failed", "Overwritten", "ToBeDeleted" ], "type": "string", "description": "Publish status" }, "canDelete": { "type": "boolean", "description": "Whether the public link can be deleted or not" }, "id": { "type": "string", "description": "Id of public link", "format": "uuid" }, "provider": { "type": "string", "description": "CDN provider of the public link" }, "recordId": { "type": "string", "description": "Id of the related record", "format": "uuid" }, "fileVersionId": { "type": "string", "description": "Id of the related file version", "format": "uuid" }, "additionalFileId": { "type": [ "null", "string" ], "description": "Id of the related additional file, if applicable", "format": "uuid" }, "fileSize": { "type": [ "null", "integer" ], "description": "File size of the related additional file, if applicable", "format": "int64" }, "renditionName": { "type": "string", "description": "Name for rendition. Valid if this is created from API" }, "origin": { "enum": [ "Order", "API" ], "type": "string", "description": "Get the origin of public link, i.e. Order or API" }, "modifiedOn": { "type": "string", "description": "Last modification datetime in UTC time.", "format": "date-time" }, "createdOn": { "type": "string", "description": "Creation datetime in UTC time.", "format": "date-time" }, "_links": { "type": "object", "properties": { "modifiedBy": { "description": "Relation to the user who modified this public link.", "$ref": "#/components/schemas/Link" }, "createdBy": { "description": "Relation to the user who created this public link.", "$ref": "#/components/schemas/Link" }, "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "modifiedBy": { "description": "Relation to the user who modified this public link. Embed via a \"select-publiclink: modifiedBy\" header.", "$ref": "#/components/schemas/UserResource" }, "createdBy": { "description": "Relation to the user who created this public link. Embed via a \"select-publiclink: createdBy\" header.", "$ref": "#/components/schemas/UserResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "A shareable, tokenized URL that grants unauthenticated access to a specific file version's content, letting a record's assets be shared with people outside the DAM tenant." }, "PublicUriPreset": { "title": "Public uri preset", "type": "object", "properties": { "presetName": { "type": "string", "description": "Name of the preset" }, "presetType": { "description": "Type of public URI preset to create or delete (original file, crop, rendition, or adaptive streaming).", "$ref": "#/components/schemas/PublicUriPresetType" } }, "description": "Public URI preset to create or delete" }, "PublicUriPresetType": { "title": "Public uri preset type", "enum": [ "OriginalFile", "Crop", "Rendition", "All", "AdaptiveStreaming" ], "type": "string", "x-enum-descriptions": [ "The original file", "A crop", "A rendition", "All presets", null ] }, "PublicationItemModel": { "title": "Publication item model", "type": "object", "properties": { "targetFileVersionId": { "type": "string", "description": "Id of the target file version the publication item applies to.", "format": "uuid" }, "pageNumber": { "type": "integer", "description": "Page number the publication item represents.", "format": "int32" } }, "description": "Describes a publication item to associate with an uploaded file version." }, "PublicationItemNonResource": { "title": "Publication item non resource", "type": "object", "properties": { "isManual": { "type": "boolean", "description": "Whether this publication/item link was created automatically by ADAM or established manually by a user. Not mandatory when setting publication items, but recommended to set it to true when doing so manually; if omitted, ADAM determines the value." }, "pageNumber": { "type": "integer", "description": "Page number where this import was used in the publication.", "format": "int32" }, "targetFileVersionId": { "type": "string", "description": "Id of file version of this import", "format": "uuid" } }, "description": "Represents a publication item" }, "RangeKeyOfDateTime": { "title": "Range key of date time", "type": "object", "properties": { "from": { "type": "string", "format": "date-time" }, "to": { "type": "string", "format": "date-time" } } }, "RangeKeyOfDecimal": { "title": "Range key of decimal", "type": "object", "properties": { "from": { "type": "number", "format": "double" }, "to": { "type": "number", "format": "double" } } }, "RangeKeyOfSpecialDate": { "title": "Range key of special date", "type": "object", "properties": { "from": { "type": "string", "format": "date-time" }, "to": { "type": "string", "format": "date-time" } } }, "RangeKeyOfTime": { "title": "Range key of time", "type": "object", "properties": { "from": { "type": "string" }, "to": { "type": "string" } } }, "RecordAccessListCollectionResource": { "title": "Record access list collection resource", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/RecordAccessListResource" }, "description": "A collection of resource items." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of a paged collection of record access lists" }, "RecordAccessListResource": { "title": "Record access list resource", "type": "object", "properties": { "id": { "type": "string", "description": "Id of this access list.", "format": "uuid" }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" }, "target": { "description": "Relation to the target access list.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "target": { "description": "Relation to the target access list. Embed via a \"select-recordaccesslist: target\" header.", "$ref": "#/components/schemas/AccessListResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "Representation of an access list connected to a record." }, "RecordAnalyticsResource": { "title": "Record analytics resource", "type": "object", "properties": { "views": { "type": "integer", "description": "The running total of views of the record", "format": "int64" }, "downloads": { "type": "integer", "description": "The running total of downloads of the record", "format": "int64" }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Provides analytics data about the Record" }, "RecordAssetType": { "title": "Record asset type", "enum": [ "LatestVersionOfMasterFile", "AllVersionsOfMasterFile", "AllVersionsOfAllFiles", "LatestVersionOfAllFiles" ], "type": "string", "x-enum-descriptions": [ "Only the latest version of the master file.", "All versions of the master file.", "All versions of all files, including additional files.", "Only the latest version of all files, including additional files." ] }, "RecordClassificationCollectionResource": { "title": "Record classification collection resource", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/RecordClassificationResource" }, "description": "A collection of resource items." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of a non-paged collection of record classifications" }, "RecordClassificationModel": { "title": "Record classification model", "type": "object", "properties": { "id": { "type": "string", "description": "Identifier of the classification.", "format": "uuid" }, "sortIndex": { "type": "integer", "description": "Sort order of this classification relative to other classifications on the record.", "format": "int32" } }, "description": "A classification assigned to a record." }, "RecordClassificationResource": { "title": "Record classification resource", "type": "object", "properties": { "sortIndex": { "type": "integer", "description": "Index of this recordclassification. This index indicates where the corresponding record is sorted in the classification.", "format": "int32" }, "isManual": { "type": "boolean", "description": "Indicates if this classification is added manually or automatically through classification mappings." }, "id": { "type": "string", "description": "Id of this classification.", "format": "uuid" }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" }, "target": { "description": "Relation to the target classification.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "target": { "description": "Relation to the target classification. Embed via a \"select-recordclassification: target\" header.", "$ref": "#/components/schemas/ClassificationResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "Representation of a RecordClassification" }, "RecordClassificationsModel": { "title": "Record classifications model", "type": "object", "properties": { "addOrUpdate": { "type": "array", "items": { "$ref": "#/components/schemas/RecordClassificationModel" }, "description": "The classifications to add or update." }, "remove": { "type": "array", "items": { "$ref": "#/components/schemas/RecordClassificationModel" }, "description": "The classifications to remove." } }, "description": "Collection of classifications to add, update, or remove on a record." }, "RecordCollectionResource": { "title": "Record collection resource", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/RecordResource" }, "description": "A collection of resource items." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of a non-paged collection of records" }, "RecordCommitBulkEditSessionCommand": { "title": "Record commit bulk edit session command", "type": "object", "properties": { "tokens": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Edit-session tokens returned when the sessions were started; pass them back to commit the sessions." }, "keepEditOpen": { "type": "boolean", "description": "When set, keeps the edit sessions open after committing instead of closing them." }, "status": { "type": "string", "description": "Lifecycle status to set on the records." }, "contentType": { "type": "string", "description": "Content type of the records." }, "fields": { "$ref": "#/components/schemas/FieldCollectionModel" } }, "description": "Commits the edit sessions of multiple records, persisting the changes made during those sessions." }, "RecordCommitEditSessionCommand": { "title": "Record commit edit session command", "type": "object", "properties": { "token": { "type": "string", "description": "Edit-session token returned when the session was started; pass it back to commit the session.", "format": "uuid" }, "tag": { "type": "string", "description": "Tag used to distinguish or categorize this record." }, "status": { "type": "string", "description": "Lifecycle status of the record." }, "contentType": { "type": "string", "description": "Content type of the record." }, "files": { "$ref": "#/components/schemas/FilesModel" }, "classifications": { "$ref": "#/components/schemas/RecordClassificationsModel" }, "fields": { "$ref": "#/components/schemas/FieldCollectionModel" }, "accessLists": { "description": "Access lists to add, update, or remove on the record.", "$ref": "#/components/schemas/AccessListCollectionModel" }, "metadata": { "description": "Metadata describing the source of the record.", "$ref": "#/components/schemas/MetadataModel" }, "aIInfluenced": { "description": "Indicates whether AI was involved in creating or influencing the record's content.", "$ref": "#/components/schemas/AIInfluenced" }, "managedContent": { "$ref": "#/components/schemas/RecordManagedContentModel" } }, "description": "Commits the edit session of a record, persisting the changes made during that session." }, "RecordCreateCommand": { "title": "Record create command", "type": "object", "properties": { "tag": { "type": "string", "description": "Tag used to distinguish or categorize this record." }, "status": { "type": "string", "description": "Lifecycle status of the record." }, "contentType": { "type": "string", "description": "Content type of the record." }, "files": { "$ref": "#/components/schemas/FilesModel" }, "classifications": { "$ref": "#/components/schemas/RecordClassificationsModel" }, "fields": { "$ref": "#/components/schemas/FieldCollectionModel" }, "accessLists": { "description": "Access lists to add, update, or remove on the record.", "$ref": "#/components/schemas/AccessListCollectionModel" }, "metadata": { "description": "Metadata describing the source of the record.", "$ref": "#/components/schemas/MetadataModel" }, "aIInfluenced": { "description": "Indicates whether AI was involved in creating or influencing the record's content.", "$ref": "#/components/schemas/AIInfluenced" }, "managedContent": { "$ref": "#/components/schemas/RecordManagedContentModel" } }, "description": "Creates a new record. The record must be classified for creation to succeed; supply at least one classification via the \"classifications\" property." }, "RecordCreateEditSessionCommand": { "title": "Record create edit session command", "type": "object", "properties": { "tag": { "type": "string", "description": "Tag used to distinguish or categorize this record." }, "status": { "type": "string", "description": "Lifecycle status of the record." }, "contentType": { "type": "string", "description": "Content type of the record." }, "files": { "$ref": "#/components/schemas/FilesModel" }, "classifications": { "$ref": "#/components/schemas/RecordClassificationsModel" }, "fields": { "$ref": "#/components/schemas/FieldCollectionModel" }, "accessLists": { "description": "Access lists to add, update, or remove on the record.", "$ref": "#/components/schemas/AccessListCollectionModel" }, "metadata": { "description": "Metadata describing the source of the record.", "$ref": "#/components/schemas/MetadataModel" }, "aIInfluenced": { "description": "Indicates whether AI was involved in creating or influencing the record's content.", "$ref": "#/components/schemas/AIInfluenced" }, "managedContent": { "$ref": "#/components/schemas/RecordManagedContentModel" } }, "description": "Starts an edit session for a new record, without persisting it until the session is committed." }, "RecordDeleteBulkEditSessionCommand": { "title": "Record delete bulk edit session command", "type": "object", "properties": { "tokens": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Edit-session tokens returned when the sessions were started; pass them back to discard the sessions." } }, "description": "Discards the edit sessions of multiple records, without persisting the changes made during those sessions." }, "RecordEditCommand": { "title": "Record edit command", "type": "object", "properties": { "tag": { "type": "string", "description": "Tag used to distinguish or categorize this record." }, "status": { "type": "string", "description": "Lifecycle status of the record." }, "contentType": { "type": "string", "description": "Content type of the record." }, "files": { "$ref": "#/components/schemas/FilesModel" }, "classifications": { "$ref": "#/components/schemas/RecordClassificationsModel" }, "fields": { "$ref": "#/components/schemas/FieldCollectionModel" }, "accessLists": { "description": "Access lists to add, update, or remove on the record.", "$ref": "#/components/schemas/AccessListCollectionModel" }, "metadata": { "description": "Metadata describing the source of the record.", "$ref": "#/components/schemas/MetadataModel" }, "aIInfluenced": { "description": "Indicates whether AI was involved in creating or influencing the record's content.", "$ref": "#/components/schemas/AIInfluenced" }, "managedContent": { "$ref": "#/components/schemas/RecordManagedContentModel" } }, "description": "Edits an existing record." }, "RecordLinkFieldConditionsResource": { "title": "Record link field conditions resource", "type": "object", "properties": { "canBeParent": { "type": "boolean", "description": "Specifies whether the record meets the requirements for being a parent record for this field. This is based upon the parent classifications or content types configured on the field definition." }, "canBeChild": { "type": "boolean", "description": "Specifies whether the record meets the requirements for being a child record for this field. This is based upon the child classifications or content types configured on the field definition." }, "canBeLink": { "type": "boolean", "description": "Specifies whether the record meets the requirements for being a linked record for this field. This is based upon the link classifications or content types configured on the field definition." } }, "description": "A resource that specifies the link types that are supported for a record based upon a record link field" }, "RecordLinkFieldDefinitionCreateCommand": { "title": "Record link field definition create command", "type": "object", "properties": { "linkType": { "type": "string", "description": "Type of link created between the records." }, "showSummaryImage": { "type": "boolean", "description": "When set to true, the summary image of the linked record is shown." }, "summaryFieldId": { "type": [ "null", "string" ], "description": "Id of the field used as the summary field for the linked record.", "format": "uuid" }, "parentClassifications": { "description": "Classifications the record containing this field must belong to. Use AddOrUpdate to add or update members, or Remove to remove them.", "$ref": "#/components/schemas/EditableIdCollectionModel" }, "parentContentTypes": { "description": "Content types the record containing this field must have. Use AddOrUpdate to add or update members, or Remove to remove them.", "$ref": "#/components/schemas/EditableStringIdCollectionModel" }, "parentLabels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelModel" }, "description": "Multi-language labels shown for this field on the record containing it." }, "childClassifications": { "description": "Classifications the linked (child) records must belong to. Use AddOrUpdate to add or update members, or Remove to remove them.", "$ref": "#/components/schemas/EditableIdCollectionModel" }, "childContentTypes": { "description": "Content types the linked (child) records must have. Use AddOrUpdate to add or update members, or Remove to remove them.", "$ref": "#/components/schemas/EditableStringIdCollectionModel" }, "childLabels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelModel" }, "description": "Multi-language labels shown for this field on the linked (child) record." }, "linkClassifications": { "description": "Classifications assigned to the record when it is linked. Use AddOrUpdate to add or update members, or Remove to remove them.", "$ref": "#/components/schemas/EditableIdCollectionModel" }, "linkContentTypes": { "description": "Content types assigned to the record when it is linked. Use AddOrUpdate to add or update members, or Remove to remove them.", "$ref": "#/components/schemas/EditableStringIdCollectionModel" }, "parentHelpTexts": { "type": "array", "items": { "$ref": "#/components/schemas/LabelModel" }, "description": "Multi-language help texts shown for this field on the record containing it." }, "childHelpTexts": { "type": "array", "items": { "$ref": "#/components/schemas/LabelModel" }, "description": "Multi-language help texts shown for this field on the linked (child) record." }, "dataType": { "description": "Data type of the field definition. Determines which other properties apply.", "$ref": "#/components/schemas/FieldDefinitionType" }, "enabledLanguages": { "description": "Languages in which this field is enabled. Use AddOrUpdate to add or update members, or Remove to remove them.", "$ref": "#/components/schemas/EditableIdCollectionModel" }, "indexed": { "type": "boolean", "description": "When set to true, the field is indexed for search." }, "inlineStyle": { "type": "string", "description": "Inline CSS style applied to the field in the DAM UI." }, "isReadOnly": { "type": "boolean", "description": "When set to true, the field cannot be edited." }, "isRequired": { "type": "boolean", "description": "When set to true, the field is required." }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelModel" }, "description": "Multi-language labels for the name of this field." }, "languageMode": { "type": "string", "description": "Language mode of the field." }, "memberships": { "description": "Field groups this field is a member of. Use AddOrUpdate to add or update members, or Remove to remove them.", "$ref": "#/components/schemas/EditableIdCollectionModel" }, "name": { "type": "string", "description": "Name of the field." }, "scope": { "type": "string", "description": "Scope of the field." }, "sortIndex": { "type": "integer", "description": "Sort index used to order the field relative to other fields.", "format": "int32" }, "tag": { "type": "string", "description": "Tag associated with the field." }, "defaultValue": { "type": "string", "description": "Default value assigned to the field." }, "resetToDefaultTriggers": { "type": "array", "items": { "type": "string" }, "description": "Names of the triggers that reset the field to its default value." }, "resetToDefaultFields": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Ids of the fields that reset this field to its default value when they change." }, "validation": { "type": "string", "description": "Validation expression applied to the field value." }, "validationErrorMessage": { "type": "string", "description": "Error message shown when validation fails." }, "validationTrigger": { "type": "string", "description": "Trigger that determines when validation is applied." }, "storageMode": { "type": "string", "description": "Storage mode of the field." }, "helpTexts": { "type": "array", "items": { "$ref": "#/components/schemas/HelpTextModel" }, "description": "Multi-language help texts for this field." } }, "description": "Command to create a record link field definition." }, "RecordLinkFieldDefinitionResource": { "title": "Record link field definition resource", "type": "object", "properties": { "linkType": { "enum": [ "OneParentOneChild", "OneParentManyChildren", "OneParentOrderedChildren", "ManyParentsOneChild", "ManyParentsManyChildren", "ManyParentsOrderedChildren", "NoParentChildRelationship" ], "type": "string", "description": "Type of record link represented by the field." }, "childClassifications": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "A collection of all the classification Id's to which a child can be linked. This property allows you to limit which records can be used as a child by specifying to which classifications every record should be linked. A record is a valid child if it is classified in at least one of the specified classifications." }, "parentClassifications": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "A collection of all the classification Id's to which a parent can be linked. This property allows you to limit which records can be used as a parent by specifying to which classifications every record should be linked. A record is a valid parent if it is classified in at least one of the specified classifications." }, "linkClassifications": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "A collection of all the classification Id's to which a record can be linked if RecordLinkType is set to NoParentChildRelationship. A record can be linked to if it is classified in at least one of the specified classifications." }, "summaryFieldId": { "type": [ "null", "string" ], "description": "Id of the field that represents the record in a record selection list.", "format": "uuid" }, "showSummaryImage": { "type": "boolean", "description": "Indication if an image must be shown in the record selection list." }, "parentLabel": { "type": "string", "description": "Label of the linked parent records in the language of the currently logged on user." }, "parentLabels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelNonResource" }, "description": "A collection of language-dependent labels for linked parent records." }, "childLabel": { "type": "string", "description": "Label of the linked child records in the language of the currently logged on user." }, "childLabels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelNonResource" }, "description": "A collection of language-dependent labels for linked child records." }, "parentHelpText": { "type": "string", "description": "Help text of the linked parent records in the language of the currently logged on user." }, "parentHelpTexts": { "type": "array", "items": { "$ref": "#/components/schemas/HelpTextNonResource" }, "description": "A collection of language-dependent help texts for linked parent records." }, "childHelpText": { "type": "string", "description": "Help text of the linked child records in the language of the currently logged on user." }, "childHelpTexts": { "type": "array", "items": { "$ref": "#/components/schemas/HelpTextNonResource" }, "description": "A collection of language-dependent help texts for linked child records." }, "parentContentTypes": { "type": "array", "items": { "type": "string" }, "description": "A collection of all the Content types that a parent can be. This property allows you to limit which records can be used as a parent by specifying which Content types every parent record can be." }, "childContentTypes": { "type": "array", "items": { "type": "string" }, "description": "A collection of all the Content types that a child can be. This property allows you to limit which records can be used as a child by specifying to which Content types every child record can be." }, "linkContentTypes": { "type": "array", "items": { "type": "string" }, "description": "A collection of all the Content types that a linked record can be. This property allows you to limit which records can be used as a link by specifying to which Content types every linked record can be." }, "label": { "type": "string", "description": "Label of this field." }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelNonResource" }, "description": "A collection of Label items." }, "dataType": { "$ref": "#/components/schemas/FieldDataType" }, "scope": { "enum": [ "RecordContentGlobal", "RecordContentClassDependent", "RecordContentFloating", "ClassificationProfileClassDependent", "UserGlobal", "FileFileTypeDependent", "FileFloating", "IndexerTaskGlobal", "FileGlobal", "ClassificationProfileFloating", "RecordContentContentTypeDependent" ], "type": "string", "description": "Scope." }, "scopeCategory": { "enum": [ "Record", "File", "Classification", "User", "IndexerTask", "MetadataTemplate" ], "type": "string", "description": "Scope category." }, "indexed": { "type": "boolean", "description": "Indicator if searching on this field is enabled." }, "languageMode": { "enum": [ "Single", "Multiple" ], "type": "string", "description": "Language mode of the field." }, "memberships": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Memberships of a field." }, "searchIndexRebuildRequired": { "type": "boolean", "description": "Indicator if a search index rebuild is required." }, "enabledLanguages": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Enabled languages." }, "id": { "type": "string", "description": "Identifier for this field.", "format": "uuid" }, "name": { "type": "string", "description": "Name for this field." }, "isRequired": { "type": "boolean", "description": "Indicates whether this field is required." }, "isReadOnly": { "type": "boolean", "description": "Indicates whether this field is read only." }, "isUniqueIdentifier": { "type": "boolean", "description": "Indicates whether this field is a unique identifier." }, "inlineStyle": { "type": "string", "description": "Inline CSS style applied to this field." }, "sortIndex": { "type": "integer", "description": "Sorting index of this field.", "format": "int32" }, "tag": { "type": "string", "description": "Tag for this field containing extra information. Opt-in: returned only when requested. Include via a \"select-fielddefinition: Tag\" header." }, "createdOn": { "type": "string", "description": "Created on the specified date in UTC time", "format": "date-time" }, "modifiedOn": { "type": "string", "description": "Modified on the specified date in UTC time", "format": "date-time" }, "defaultValue": { "type": "string", "description": "Default value of this field." }, "resetToDefaultTriggers": { "type": "array", "items": { "enum": [ "None", "OnNewField", "OnLoad", "OnSave", "OnAnyFileChange", "OnReclassifyRecord", "OnAnyChange", "OnFieldChange", "OnMasterFileChange", "OnCurrentFileChange", "OnFieldDefinitionChanged", "OnDuplicateRecord", "OnRecordStatusChange" ], "type": "string" }, "description": "'reset to default triggers' value of this field." }, "validation": { "type": "string", "description": "Validation of this field." }, "validationErrorMessage": { "type": "string", "description": "Error message of this field." }, "validationTrigger": { "enum": [ "None", "WhenNeeded", "Always" ], "type": "string", "description": "Trigger that determines when validation is evaluated for this field." }, "storageMode": { "enum": [ "None", "NonEmptyValues", "AllValues", "LogChanges" ], "type": "string", "description": "Storage mode of this field." }, "resetToDefaultFields": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Fields that trigger this field to be reset back to its default value. This is only used if \"ResetToDefaultTriggers\" is set to \"OnFieldChange\"." }, "helpText": { "type": "string", "description": "Help text of this field." }, "helpTexts": { "type": "array", "items": { "$ref": "#/components/schemas/HelpTextNonResource" }, "description": "A collection of HelpText items." }, "_links": { "type": "object", "properties": { "createdBy": { "description": "Relation to the user who created this field definition.", "$ref": "#/components/schemas/Link" }, "modifiedBy": { "description": "Relation to the user who last modified this field definition.", "$ref": "#/components/schemas/Link" }, "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "createdBy": { "description": "Relation to the user who created this field definition. Embed via a \"select-fielddefinition: createdBy\" header.", "$ref": "#/components/schemas/UserResource" }, "modifiedBy": { "description": "Relation to the user who last modified this field definition. Embed via a \"select-fielddefinition: modifiedBy\" header.", "$ref": "#/components/schemas/UserResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "Representation of the definition of a record link field" }, "RecordLinkFieldResource": { "title": "Record link field resource", "type": "object", "properties": { "recordLinkConditions": { "description": "Contains properties specifying if the record can be a parent, child or a link for this field. Opt-in: returned only when requested. Include via a \"select-field: RecordLinkConditions\" header.", "$ref": "#/components/schemas/RecordLinkFieldConditionsResource" }, "dataType": { "$ref": "#/components/schemas/FieldDataType" }, "fieldName": { "type": "string", "description": "Name of this field." }, "label": { "type": "string", "description": "Label of this field." }, "id": { "type": "string", "description": "Id of this field.", "format": "uuid" }, "localizedValues": { "type": "array", "items": { "$ref": "#/components/schemas/RecordLinkFieldValues" }, "description": "Language specific data of this field." }, "inheritanceState": { "enum": [ "None", "Inherited" ], "type": [ "null", "string" ], "description": "Inheritance State of this field. Opt-in: returned only when requested. Include via a \"select-field: InheritanceState\" header." }, "inheritable": { "type": [ "null", "boolean" ], "description": "Whether the field value can be used as a parent in inheritance hierarchy. Opt-in: returned only when requested. Include via a \"select-field: Inheritable\" header." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" }, "definition": { "description": "Relation to the field definition.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "definition": { "description": "Relation to the field definition. Embed via a \"select-recordlinkfield: definition\" header.", "$ref": "#/components/schemas/FieldDefinitionResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "Representation of a RecordLinkField" }, "RecordLinkFieldValues": { "title": "Record link field values", "type": "object", "properties": { "links": { "type": "array", "items": { "$ref": "#/components/schemas/RecordLinkItemNonResource" }, "description": "The collection of links." }, "parents": { "type": "array", "items": { "$ref": "#/components/schemas/RecordLinkItemNonResource" }, "description": "The collection of parents." }, "children": { "type": "array", "items": { "$ref": "#/components/schemas/RecordLinkItemNonResource" }, "description": "The collection of children." }, "languageId": { "type": "string", "description": "The language id.", "format": "uuid" }, "readOnly": { "type": [ "null", "boolean" ], "description": "Tells if the field is read-only." }, "modifiedOn": { "type": "string", "description": "Contains the date/time when the field is last modified.", "format": "date-time" } }, "description": "Record link field values." }, "RecordLinkItemArrayParameterModel": { "title": "Record link item array parameter model", "oneOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/RecordLinkItemModel" } }, { "$ref": "#/components/schemas/RecordLinkItemFieldModel" } ], "description": "Record links value for a field, provided either as a plain array of record links or as an add/remove update object." }, "RecordLinkItemFieldModel": { "title": "Record link item field model", "type": "object", "properties": { "addOrUpdate": { "type": "array", "items": { "$ref": "#/components/schemas/RecordLinkItemModel" }, "description": "The record links to add or update." }, "remove": { "type": "array", "items": { "$ref": "#/components/schemas/RecordLinkItemModel" }, "description": "The record links to remove." } }, "description": "Add/remove update for a record links field value." }, "RecordLinkItemModel": { "title": "Record link item model", "type": "object", "properties": { "recordId": { "type": "string", "description": "The id of the linked record.", "format": "uuid" }, "tag": { "type": "string", "description": "The tag associated with this link." } }, "description": "A single record link entry for a record links field." }, "RecordLinkItemNonResource": { "title": "Record link item non resource", "type": "object", "properties": { "recordId": { "type": "string", "description": "The record Id (represented as a GUID value).", "format": "uuid" }, "modifiedOn": { "type": "string", "description": "Contains the date/time when the item was last modified.", "format": "date-time" }, "tag": { "type": "string", "description": "The tag. Opt-in: returned only when requested. Include via a \"select-field: Tag\" header." } }, "description": "Record link item." }, "RecordListFieldDefinitionCreateCommand": { "title": "Record list field definition create command", "type": "object", "properties": { "summaryFieldId": { "type": [ "null", "string" ], "description": "Id of the field used as the summary field for the linked records.", "format": "uuid" }, "dataType": { "description": "Data type of the field definition. Determines which other properties apply.", "$ref": "#/components/schemas/FieldDefinitionType" }, "enabledLanguages": { "description": "Languages in which this field is enabled. Use AddOrUpdate to add or update members, or Remove to remove them.", "$ref": "#/components/schemas/EditableIdCollectionModel" }, "indexed": { "type": "boolean", "description": "When set to true, the field is indexed for search." }, "inlineStyle": { "type": "string", "description": "Inline CSS style applied to the field in the DAM UI." }, "isReadOnly": { "type": "boolean", "description": "When set to true, the field cannot be edited." }, "isRequired": { "type": "boolean", "description": "When set to true, the field is required." }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelModel" }, "description": "Multi-language labels for the name of this field." }, "languageMode": { "type": "string", "description": "Language mode of the field." }, "memberships": { "description": "Field groups this field is a member of. Use AddOrUpdate to add or update members, or Remove to remove them.", "$ref": "#/components/schemas/EditableIdCollectionModel" }, "name": { "type": "string", "description": "Name of the field." }, "scope": { "type": "string", "description": "Scope of the field." }, "sortIndex": { "type": "integer", "description": "Sort index used to order the field relative to other fields.", "format": "int32" }, "tag": { "type": "string", "description": "Tag associated with the field." }, "defaultValue": { "type": "string", "description": "Default value assigned to the field." }, "resetToDefaultTriggers": { "type": "array", "items": { "type": "string" }, "description": "Names of the triggers that reset the field to its default value." }, "resetToDefaultFields": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Ids of the fields that reset this field to its default value when they change." }, "validation": { "type": "string", "description": "Validation expression applied to the field value." }, "validationErrorMessage": { "type": "string", "description": "Error message shown when validation fails." }, "validationTrigger": { "type": "string", "description": "Trigger that determines when validation is applied." }, "storageMode": { "type": "string", "description": "Storage mode of the field." }, "helpTexts": { "type": "array", "items": { "$ref": "#/components/schemas/HelpTextModel" }, "description": "Multi-language help texts for this field." } }, "description": "Command to create a record list field definition." }, "RecordListFieldDefinitionResource": { "title": "Record list field definition resource", "type": "object", "properties": { "summaryFieldId": { "type": [ "null", "string" ], "description": "Specifies the id of the summary field (if any)", "format": "uuid" }, "label": { "type": "string", "description": "Label of this field." }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelNonResource" }, "description": "A collection of Label items." }, "dataType": { "$ref": "#/components/schemas/FieldDataType" }, "scope": { "enum": [ "RecordContentGlobal", "RecordContentClassDependent", "RecordContentFloating", "ClassificationProfileClassDependent", "UserGlobal", "FileFileTypeDependent", "FileFloating", "IndexerTaskGlobal", "FileGlobal", "ClassificationProfileFloating", "RecordContentContentTypeDependent" ], "type": "string", "description": "Scope." }, "scopeCategory": { "enum": [ "Record", "File", "Classification", "User", "IndexerTask", "MetadataTemplate" ], "type": "string", "description": "Scope category." }, "indexed": { "type": "boolean", "description": "Indicator if searching on this field is enabled." }, "languageMode": { "enum": [ "Single", "Multiple" ], "type": "string", "description": "Language mode of the field." }, "memberships": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Memberships of a field." }, "searchIndexRebuildRequired": { "type": "boolean", "description": "Indicator if a search index rebuild is required." }, "enabledLanguages": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Enabled languages." }, "id": { "type": "string", "description": "Identifier for this field.", "format": "uuid" }, "name": { "type": "string", "description": "Name for this field." }, "isRequired": { "type": "boolean", "description": "Indicates whether this field is required." }, "isReadOnly": { "type": "boolean", "description": "Indicates whether this field is read only." }, "isUniqueIdentifier": { "type": "boolean", "description": "Indicates whether this field is a unique identifier." }, "inlineStyle": { "type": "string", "description": "Inline CSS style applied to this field." }, "sortIndex": { "type": "integer", "description": "Sorting index of this field.", "format": "int32" }, "tag": { "type": "string", "description": "Tag for this field containing extra information. Opt-in: returned only when requested. Include via a \"select-fielddefinition: Tag\" header." }, "createdOn": { "type": "string", "description": "Created on the specified date in UTC time", "format": "date-time" }, "modifiedOn": { "type": "string", "description": "Modified on the specified date in UTC time", "format": "date-time" }, "defaultValue": { "type": "string", "description": "Default value of this field." }, "resetToDefaultTriggers": { "type": "array", "items": { "enum": [ "None", "OnNewField", "OnLoad", "OnSave", "OnAnyFileChange", "OnReclassifyRecord", "OnAnyChange", "OnFieldChange", "OnMasterFileChange", "OnCurrentFileChange", "OnFieldDefinitionChanged", "OnDuplicateRecord", "OnRecordStatusChange" ], "type": "string" }, "description": "'reset to default triggers' value of this field." }, "validation": { "type": "string", "description": "Validation of this field." }, "validationErrorMessage": { "type": "string", "description": "Error message of this field." }, "validationTrigger": { "enum": [ "None", "WhenNeeded", "Always" ], "type": "string", "description": "Trigger that determines when validation is evaluated for this field." }, "storageMode": { "enum": [ "None", "NonEmptyValues", "AllValues", "LogChanges" ], "type": "string", "description": "Storage mode of this field." }, "resetToDefaultFields": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Fields that trigger this field to be reset back to its default value. This is only used if \"ResetToDefaultTriggers\" is set to \"OnFieldChange\"." }, "helpText": { "type": "string", "description": "Help text of this field." }, "helpTexts": { "type": "array", "items": { "$ref": "#/components/schemas/HelpTextNonResource" }, "description": "A collection of HelpText items." }, "_links": { "type": "object", "properties": { "createdBy": { "description": "Relation to the user who created this field definition.", "$ref": "#/components/schemas/Link" }, "modifiedBy": { "description": "Relation to the user who last modified this field definition.", "$ref": "#/components/schemas/Link" }, "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "createdBy": { "description": "Relation to the user who created this field definition. Embed via a \"select-fielddefinition: createdBy\" header.", "$ref": "#/components/schemas/UserResource" }, "modifiedBy": { "description": "Relation to the user who last modified this field definition. Embed via a \"select-fielddefinition: modifiedBy\" header.", "$ref": "#/components/schemas/UserResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "Representation of the definition of a record list field" }, "RecordListFieldResource": { "title": "Record list field resource", "type": "object", "properties": { "dataType": { "$ref": "#/components/schemas/FieldDataType" }, "fieldName": { "type": "string", "description": "Name of this field." }, "label": { "type": "string", "description": "Label of this field." }, "id": { "type": "string", "description": "Id of this field.", "format": "uuid" }, "localizedValues": { "type": "array", "items": { "$ref": "#/components/schemas/RecordListFieldValues" }, "description": "Language specific data of this field." }, "inheritanceState": { "enum": [ "None", "Inherited" ], "type": [ "null", "string" ], "description": "Inheritance State of this field. Opt-in: returned only when requested. Include via a \"select-field: InheritanceState\" header." }, "inheritable": { "type": [ "null", "boolean" ], "description": "Whether the field value can be used as a parent in inheritance hierarchy. Opt-in: returned only when requested. Include via a \"select-field: Inheritable\" header." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" }, "definition": { "description": "Relation to the field definition.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "definition": { "description": "Relation to the field definition. Embed via a \"select-recordlistfield: definition\" header.", "$ref": "#/components/schemas/FieldDefinitionResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "Representation of a RecordListField" }, "RecordListFieldValues": { "title": "Record list field values", "type": "object", "properties": { "values": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Language-specific collection of record Ids (represented as GUID values)." }, "languageId": { "type": "string", "description": "The language id.", "format": "uuid" }, "readOnly": { "type": [ "null", "boolean" ], "description": "Tells if the field is read-only." }, "modifiedOn": { "type": "string", "description": "Contains the date/time when the field is last modified.", "format": "date-time" } }, "description": "The collection of language-specific values stored in the RecordList field." }, "RecordLockCreateCommand": { "title": "Record lock create command", "type": "object", "properties": { "integrationId": { "type": "string", "description": "Identifier of the integration that owns this lock." }, "uri": { "type": "string", "description": "URI associated with the lock, e.g. a link back to the external system holding the lock." }, "reason": { "type": "string", "description": "Reason for locking the record." } }, "description": "Creates a lock on a record, preventing it from being modified by others." }, "RecordLockResource": { "title": "Record lock resource", "type": "object", "properties": { "lockId": { "type": "string", "description": "LockId of this lock.", "format": "uuid" }, "integrationId": { "type": "string", "description": "IntegrationId of this lock." }, "uri": { "type": "string", "description": "Uri of this lock." }, "reason": { "type": "string", "description": "Reason of this lock." }, "lockedOn": { "type": "string", "description": "LockedOn of this lock.", "format": "date-time" }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of the lock on a record." }, "RecordLocksResource": { "title": "Record locks resource", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/RecordLockResource" }, "description": "Represents active locks on an object" }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of the locks on a record" }, "RecordMaintenanceJobCommand": { "title": "Record maintenance job command", "type": "object", "properties": { "creatorEmail": { "type": "string", "description": "Email address of the user the job is created on behalf of." }, "disableNotification": { "type": "boolean", "description": "When set to true, suppresses notifications for this job." }, "earliestStartDate": { "type": [ "null", "string" ], "description": "Earliest date and time at which the job is allowed to start executing.", "format": "date-time" }, "priority": { "enum": [ "High", "Medium" ], "type": "string", "description": "Priority used to schedule this job relative to other maintenance jobs." }, "type": { "enum": [ "Classification", "Record", "ExportAuditTrail", "BulkRecord", "AcceptDownloadOrderAgreement", "BulkCollection", "ExportContentItemsList" ], "type": "string", "description": "Type of maintenance job to create." }, "targets": { "type": "array", "items": { "$ref": "#/components/schemas/RecordMaintenanceJobTargetModel" }, "description": "Targets the job's actions are applied to." }, "actions": { "type": "array", "items": { "$ref": "#/components/schemas/ActionModel" }, "description": "Actions to execute for each target of this job." }, "title": { "type": "string", "description": "Title of the job. For a download or contact-sheet order this is shown on the Downloads page in Content Workspace; if omitted, it defaults to the file name, or \"X items\" when multiple files were ordered. Either plain text, or a JSON string of the form {\"studioName\":\"...\",\"moduleName\":\"...\",\"translationKey\":\"...\"} to look up a translated value for non-English users (see the Localization > Translations section of the DAM Administrator Guide for how translations are registered)." }, "description": { "type": "string", "description": "Description of the job. For a download or contact-sheet order this is shown on the Downloads page in Content Workspace; if omitted, it defaults to \"Download\". Accepts the same plain-text-or-translation-key JSON format as Title." }, "errorMode": { "type": "string", "description": "Determines how the job behaves when one of its targets fails to execute." } }, "description": "Creates a maintenance job that executes its actions against a single record." }, "RecordMaintenanceJobTargetModel": { "title": "Record maintenance job target model", "type": "object", "properties": { "recordId": { "type": "string", "description": "Id of the record this job's actions are applied to.", "format": "uuid" }, "forceRetry": { "type": "boolean", "description": "When set to true, forces this target to be retried even if it previously failed." }, "tag": { "type": "string", "description": "Free-form tag that can be used to identify or group this target." } }, "description": "Target for a record maintenance job." }, "RecordMaintenanceTargetResource": { "title": "Record maintenance target resource", "type": "object", "properties": { "recordId": { "type": "string", "description": "The Id of the Record this target represents.", "format": "uuid" }, "id": { "type": "string", "description": "The Id of this target.", "format": "uuid" }, "attempt": { "type": "integer", "description": "Value indicating how many times the maintenance manager has already tried to execute this target.", "format": "int32" }, "errorDetails": { "type": "string", "description": "Detailed information about the error that occurred if this target failed to execute successfully." }, "executionTime": { "type": "string", "description": "The amount of time needed to execute this target" }, "forceRetry": { "type": "boolean", "description": "Value indicating whether or not a new maintenance job will be created to retry this target after it finished its execution." }, "message": { "type": "string", "description": "The message that was set during the execution of this target" }, "status": { "description": "The status of this target.", "$ref": "#/components/schemas/MaintenanceTargetResourceStatus" }, "tag": { "type": "string", "description": "Custom data associated with this target, if any." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of a record maintenance target" }, "RecordManagedContentModel": { "title": "Record managed content model", "type": "object", "properties": { "state": { "$ref": "#/components/schemas/ManagedContentState" }, "name": { "type": "string", "description": "Name of the managed content." }, "data": { "type": "string", "description": "Data of the managed content." }, "preview": { "$ref": "#/components/schemas/ManagedContentPreviewModel" } }, "description": "Managed content associated with a record." }, "RecordManagedContentResource": { "title": "Record managed content resource", "type": "object", "properties": { "name": { "type": "string", "description": "Name of the managed content." }, "state": { "type": "string", "description": "State of the managed content." }, "data": { "type": "string", "description": "Data of the managed content." }, "hasWorkingDraft": { "type": "boolean", "description": "Value indicating whether the managed content has a working draft." }, "hasBeenPublished": { "type": "boolean", "description": "Value indicating whether the managed content has been published." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of the managed content of a record." }, "RecordPagedCollectionResource": { "title": "Record paged collection resource", "type": "object", "properties": { "nextCursor": { "type": [ "null", "string" ], "description": "Opaque cursor for the next page. Pass back as cursor in the next request to continue from exactly this position at constant cost per page, regardless of depth. Null when this is the last page or the result set is empty." }, "pageNumber": { "type": [ "null", "integer" ], "description": "The current page of this paged collection.", "format": "int32" }, "pageSize": { "type": [ "null", "integer" ], "description": "The current page size of this paged collection.", "format": "int32" }, "skip": { "type": [ "null", "integer" ], "description": "The current skip size of this paged collection.", "format": "int32" }, "take": { "type": [ "null", "integer" ], "description": "The current take size of this paged collection.", "format": "int32" }, "totalCount": { "type": "integer", "description": "The total count of items in this paged collection, not just on the current page.", "format": "int64" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/RecordResource" }, "description": "One page of this paged collection, which is a subcollection of the complete collection." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" }, "first": { "description": "A link to the first page of this paged collection.", "$ref": "#/components/schemas/Link" }, "prev": { "description": "A link to the previous page of this paged collection.", "$ref": "#/components/schemas/Link" }, "next": { "description": "A link to the next page of this paged collection.", "$ref": "#/components/schemas/Link" }, "last": { "description": "A link to the last page of this paged collection.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of a paged collection of records" }, "RecordPatchBulkEditSessionCommand": { "title": "Record patch bulk edit session command", "type": "object", "properties": { "tokens": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Edit-session tokens returned when the sessions were started; pass them back to patch the sessions." }, "status": { "type": "string", "description": "Lifecycle status to set on the records." }, "contentType": { "type": "string", "description": "Content type of the records." }, "fields": { "$ref": "#/components/schemas/FieldCollectionModel" }, "disableValidations": { "type": "boolean", "description": "When set, skips field and business rule validations." } }, "description": "Applies a partial update to the edit sessions of multiple records, without closing those sessions." }, "RecordPatchEditSessionCommand": { "title": "Record patch edit session command", "type": "object", "properties": { "token": { "type": "string", "description": "Edit-session token returned when the session was started; pass it back to patch the session.", "format": "uuid" }, "tag": { "type": "string", "description": "Tag used to distinguish or categorize this record." }, "status": { "type": "string", "description": "Lifecycle status of the record." }, "contentType": { "type": "string", "description": "Content type of the record." }, "files": { "$ref": "#/components/schemas/FilesModel" }, "classifications": { "$ref": "#/components/schemas/RecordClassificationsModel" }, "fields": { "$ref": "#/components/schemas/FieldCollectionModel" }, "accessLists": { "description": "Access lists to add, update, or remove on the record.", "$ref": "#/components/schemas/AccessListCollectionModel" }, "metadata": { "description": "Metadata describing the source of the record.", "$ref": "#/components/schemas/MetadataModel" }, "aIInfluenced": { "description": "Indicates whether AI was involved in creating or influencing the record's content.", "$ref": "#/components/schemas/AIInfluenced" }, "managedContent": { "$ref": "#/components/schemas/RecordManagedContentModel" } }, "description": "Applies a partial update to the edit session of a record, without closing that session." }, "RecordPermissionsResource": { "title": "Record permissions resource", "type": "object", "properties": { "canRead": { "type": "boolean", "description": "Indicates whether the current user has read permissions on this object." }, "canReadAllVersions": { "type": "boolean", "description": "Indicates whether the current user has read permissions all versions of this object." }, "canModify": { "type": "boolean", "description": "Indicates whether the current user has modify permissions on this object." }, "canDelete": { "type": "boolean", "description": "Indicates whether the current user has delete permissions on this object." }, "hasFullControl": { "type": "boolean", "description": "Indicates whether the current user has full control permissions on this object." }, "canDownload": { "type": "boolean", "description": "Indicates whether the current user has download permissions on this object." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of the permissions on a record" }, "RecordResource": { "title": "Record resource", "type": "object", "properties": { "id": { "type": "string", "description": "Id of this record.", "format": "uuid" }, "status": { "enum": [ "Draft", "Released", "Archived", "Unpublished" ], "type": "string", "description": "Status of this record. Out of the box options are: Draft; Released ; Archived ;" }, "contentType": { "type": "string", "description": "Value for the ContentType of this object. Out of the box options are: Record: if the record is not typed. ; Video: if the record is a video. ; Asset: in all other cases. ; To get a list of all possible values you can search on the /contenttypes endpoint." }, "title": { "type": "string", "description": "Display title of the record as configured on the records content type title configuration. This can be the value of a field the filename of the latest master file. Opt-in: returned only when requested. Include via a \"select-record: Title\" header." }, "tag": { "type": "string", "description": "Value for the Tag of this object. The value of this property should be valid Xml. Opt-in: returned only when requested. Include via a \"select-record: Tag\" header." }, "textContent": { "type": "string", "description": "Text content of this record. Opt-in: returned only when requested. Include via a \"select-record: TextContent\" header." }, "aIInfluenced": { "enum": [ "Unknown", "No", "Yes" ], "type": "string", "description": "Indicates if this record has contents that was influenced by AI." }, "hasImageOverlay": { "type": [ "null", "boolean" ], "description": "Status which determines whether an image overlay should be shown or not." }, "modifiedOn": { "type": "string", "description": "Last modification datetime in UTC time.", "format": "date-time" }, "createdOn": { "type": "string", "description": "Creation datetime in UTC time.", "format": "date-time" }, "_links": { "type": "object", "properties": { "fields": { "description": "Relation to a collection of fields.", "$ref": "#/components/schemas/Link" }, "files": { "description": "Relation to a collection of files.", "$ref": "#/components/schemas/Link" }, "preview": { "description": "Relation to an image with the size of a preview.", "$ref": "#/components/schemas/Link" }, "thumbnail": { "description": "Relation to an image with the size of a thumbnail.", "$ref": "#/components/schemas/Link" }, "masterFile": { "description": "Relation to the masterfile.", "$ref": "#/components/schemas/Link" }, "masterFileLatestVersion": { "description": "Relation to latest version of the masterfile.", "$ref": "#/components/schemas/Link" }, "masterFileLatestPublishedVersion": { "description": "Relation to latest published version of the masterfile.", "$ref": "#/components/schemas/Link" }, "classifications": { "description": "Relation to a collection of record classifications.", "$ref": "#/components/schemas/Link" }, "accessLists": { "description": "Relation to a collection of record access lists.", "$ref": "#/components/schemas/Link" }, "permissions": { "description": "Relation to the permissions.", "$ref": "#/components/schemas/Link" }, "locks": { "description": "Relation to the record locks.", "$ref": "#/components/schemas/Link" }, "analyticsData": { "description": "Relation to the record's analytics data.", "$ref": "#/components/schemas/Link" }, "managedContent": { "description": "Relation to the record's managed content data.", "$ref": "#/components/schemas/Link" }, "modifiedBy": { "description": "Relation to the user who last modified this record.", "$ref": "#/components/schemas/Link" }, "createdBy": { "description": "Relation to the user who created this record.", "$ref": "#/components/schemas/Link" }, "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "fields": { "description": "Relation to a collection of fields. Embed via a \"select-record: fields\" header.", "$ref": "#/components/schemas/FieldCollectionResource" }, "files": { "description": "Relation to a collection of files. Embed via a \"select-record: files\" header.", "$ref": "#/components/schemas/FileCollectionResource" }, "preview": { "description": "Relation to an image with the size of a preview. Embed via a \"select-record: preview\" header.", "$ref": "#/components/schemas/ImageResource" }, "thumbnail": { "description": "Relation to an image with the size of a thumbnail. Embed via a \"select-record: thumbnail\" header.", "$ref": "#/components/schemas/ImageResource" }, "masterFile": { "description": "Relation to the masterfile. Embed via a \"select-record: masterFile\" header.", "$ref": "#/components/schemas/FileResource" }, "masterFileLatestVersion": { "description": "Relation to latest version of the masterfile. Embed via a \"select-record: masterFileLatestVersion\" header.", "$ref": "#/components/schemas/FileVersionResource" }, "masterFileLatestPublishedVersion": { "description": "Relation to latest published version of the masterfile. Embed via a \"select-record: masterFileLatestPublishedVersion\" header.", "$ref": "#/components/schemas/FileVersionResource" }, "classifications": { "description": "Relation to a collection of record classifications. Embed via a \"select-record: classifications\" header.", "$ref": "#/components/schemas/RecordClassificationCollectionResource" }, "accessLists": { "description": "Relation to a collection of record access lists. Embed via a \"select-record: accessLists\" header.", "$ref": "#/components/schemas/RecordAccessListCollectionResource" }, "permissions": { "description": "Relation to the permissions. Embed via a \"select-record: permissions\" header.", "$ref": "#/components/schemas/RecordPermissionsResource" }, "locks": { "description": "Relation to the record locks. Embed via a \"select-record: locks\" header.", "$ref": "#/components/schemas/RecordLocksResource" }, "analyticsData": { "description": "Relation to the record's analytics data. Embed via a \"select-record: analyticsData\" header.", "$ref": "#/components/schemas/RecordAnalyticsResource" }, "managedContent": { "description": "Relation to the record's managed content data. Embed via a \"select-record: managedContent\" header.", "$ref": "#/components/schemas/RecordManagedContentResource" }, "modifiedBy": { "description": "Relation to the user who last modified this record. Embed via a \"select-record: modifiedBy\" header.", "$ref": "#/components/schemas/UserResource" }, "createdBy": { "description": "Relation to the user who created this record. Embed via a \"select-record: createdBy\" header.", "$ref": "#/components/schemas/UserResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "The core content entity in DAM - a piece of digital content (e.g. an image, video, or document) together with its metadata fields, classifications, and attached files. Includes an action to download the binary image data of the record's master file preview or thumbnail directly." }, "RecordSearchModel": { "title": "Record search model", "type": "object", "properties": { "searchExpression": { "description": "Search expression used to filter records.", "$ref": "#/components/schemas/SearchExpressionModel" }, "facets": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/NumericFieldFacetModel" }, { "$ref": "#/components/schemas/NumericFieldRangeFacetModel" }, { "$ref": "#/components/schemas/NumericFieldRangeFilterModel" }, { "$ref": "#/components/schemas/ClassificationFacetModel" }, { "$ref": "#/components/schemas/UserFacetModel" }, { "$ref": "#/components/schemas/FileTypeFacetModel" }, { "$ref": "#/components/schemas/OptionListFieldFacetModel" }, { "$ref": "#/components/schemas/TextFieldFacetModel" }, { "$ref": "#/components/schemas/DateTimeFieldRangeFacetModel" }, { "$ref": "#/components/schemas/DateFieldRangeFacetModel" }, { "$ref": "#/components/schemas/DateFieldRangeFilterModel" }, { "$ref": "#/components/schemas/DateTimeFacetModel" }, { "$ref": "#/components/schemas/TimeFieldRangeFacetModel" }, { "$ref": "#/components/schemas/TextListFieldFacetModel" }, { "$ref": "#/components/schemas/ContentTypeFacetModel" }, { "$ref": "#/components/schemas/ClassificationListFieldFacetModel" } ], "discriminator": { "propertyName": "type", "mapping": { "NumericField": "#/components/schemas/NumericFieldFacetModel", "NumericFieldRange": "#/components/schemas/NumericFieldRangeFacetModel", "NumericFieldRangeFilter": "#/components/schemas/NumericFieldRangeFilterModel", "Classification": "#/components/schemas/ClassificationFacetModel", "CreatedBy": "#/components/schemas/UserFacetModel", "ModifiedBy": "#/components/schemas/UserFacetModel", "FileType": "#/components/schemas/FileTypeFacetModel", "OptionListField": "#/components/schemas/OptionListFieldFacetModel", "TextField": "#/components/schemas/TextFieldFacetModel", "DateTimeFieldRange": "#/components/schemas/DateTimeFieldRangeFacetModel", "DateFieldRange": "#/components/schemas/DateFieldRangeFacetModel", "DateFieldRangeFilter": "#/components/schemas/DateFieldRangeFilterModel", "CreatedOn": "#/components/schemas/DateTimeFacetModel", "ModifiedOn": "#/components/schemas/DateTimeFacetModel", "TimeFieldRange": "#/components/schemas/TimeFieldRangeFacetModel", "TextListField": "#/components/schemas/TextListFieldFacetModel", "ContentType": "#/components/schemas/ContentTypeFacetModel", "ClassificationListField": "#/components/schemas/ClassificationListFieldFacetModel" } } }, "description": "Facets to apply and compute for this search. Limited to 12 facets per request - if more are submitted, only the first 12 are computed, and the rest are listed by name in the response's truncatedFacets property." }, "logRequest": { "type": "boolean", "description": "Whether this search is logged in the Aprimo DAM Enterprise Search Log. If unset or false, no logging occurs. When true, the query and its result information are logged, including an \"origin\" value read from the Referer header (falling back to the User-Agent header if Referer is absent) - useful to distinguish search sources within or across applications. Also controlled by the .enterpriseSearchActionsToLog and .enterpriseSearchLogDetail settings; see the Aprimo DAM Administrator Guide." }, "ignoreInvalidFacets": { "type": "boolean", "description": "Whether invalid facets are silently ignored rather than causing an error. A facet is invalid if it points to a field that doesn't exist, that the user has no read rights to, or that isn't enabled for searching. If unset or false, a request containing an invalid facet fails with an error instead of executing." }, "userQuery": { "type": [ "null", "boolean" ], "description": "Value indicating whether this is a user-initiated query." }, "cursor": { "type": "string", "description": "Opaque cursor returned by a previous page's response as nextCursor. When set, the server resumes paging from that position at constant cost per page, regardless of depth. Overrides page/skip when present." } }, "description": "Represents a request to search records." }, "RecordStartBulkEditSessionCommand": { "title": "Record start bulk edit session command", "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Identifiers of the records to start edit sessions for." }, "status": { "type": "string", "description": "Lifecycle status to set on the records." }, "contentType": { "type": "string", "description": "Content type of the records." }, "fields": { "$ref": "#/components/schemas/FieldCollectionModel" }, "disableValidations": { "type": "boolean", "description": "When set, skips field and business rule validations." } }, "description": "Starts edit sessions for multiple records, without persisting any changes until the sessions are committed." }, "RecordStartEditSessionCommand": { "title": "Record start edit session command", "type": "object", "properties": { "tag": { "type": "string", "description": "Tag used to distinguish or categorize this record." }, "status": { "type": "string", "description": "Lifecycle status of the record." }, "contentType": { "type": "string", "description": "Content type of the record." }, "files": { "$ref": "#/components/schemas/FilesModel" }, "classifications": { "$ref": "#/components/schemas/RecordClassificationsModel" }, "fields": { "$ref": "#/components/schemas/FieldCollectionModel" }, "accessLists": { "description": "Access lists to add, update, or remove on the record.", "$ref": "#/components/schemas/AccessListCollectionModel" }, "metadata": { "description": "Metadata describing the source of the record.", "$ref": "#/components/schemas/MetadataModel" }, "aIInfluenced": { "description": "Indicates whether AI was involved in creating or influencing the record's content.", "$ref": "#/components/schemas/AIInfluenced" }, "managedContent": { "$ref": "#/components/schemas/RecordManagedContentModel" } }, "description": "Starts an edit session for a record, allowing its changes to be patched and later committed or discarded." }, "RecordStatusChangedRuleConditionModel": { "title": "Record status changed rule condition model", "type": "object", "properties": { "index": { "type": "integer", "description": "Index of the condition within the rule's condition collection", "format": "int32" }, "conditionType": { "description": "Type of condition to be evaluated.", "$ref": "#/components/schemas/RuleConditionDataType" } }, "description": "Model for RecordStatusChanged rule condition" }, "RecordStatusChangedRuleConditionNonResource": { "title": "Record status changed rule condition non resource", "type": "object", "properties": { "index": { "type": "integer", "description": "Index of a rule condition in collection", "format": "int32" }, "conditionType": { "description": "Data type of this rule condition", "$ref": "#/components/schemas/RuleConditionDataType" } }, "description": "Representation of record status changed rule condition" }, "RecordStatusChangedToRuleConditionModel": { "title": "Record status changed to rule condition model", "type": "object", "properties": { "status": { "type": "string", "description": "Status" }, "index": { "type": "integer", "description": "Index of the condition within the rule's condition collection", "format": "int32" }, "conditionType": { "description": "Type of condition to be evaluated.", "$ref": "#/components/schemas/RuleConditionDataType" } }, "description": "Model for RecordStatusSetTo rule condition" }, "RecordStatusChangedToRuleConditionNonResource": { "title": "Record status changed to rule condition non resource", "type": "object", "properties": { "status": { "type": "string", "description": "Status" }, "index": { "type": "integer", "description": "Index of a rule condition in collection", "format": "int32" }, "conditionType": { "description": "Data type of this rule condition", "$ref": "#/components/schemas/RuleConditionDataType" } }, "description": "Representation of record status set to rule condition" }, "RecordStatusIsRuleConditionModel": { "title": "Record status is rule condition model", "type": "object", "properties": { "status": { "type": "string", "description": "Status" }, "index": { "type": "integer", "description": "Index of the condition within the rule's condition collection", "format": "int32" }, "conditionType": { "description": "Type of condition to be evaluated.", "$ref": "#/components/schemas/RuleConditionDataType" } }, "description": "Model for RecordStatusIs rule condition" }, "RecordStatusIsRuleConditionNonResource": { "title": "Record status is rule condition non resource", "type": "object", "properties": { "status": { "type": "string", "description": "Status" }, "index": { "type": "integer", "description": "Index of a rule condition in collection", "format": "int32" }, "conditionType": { "description": "Data type of this rule condition", "$ref": "#/components/schemas/RuleConditionDataType" } }, "description": "Representation of record status is rule condition" }, "RecordTargetType": { "title": "Record target type", "enum": [ "None", "Document", "MasterThumbnail", "AllThumbnails", "MasterPreview", "AllPreviews", "AdditionalFiles", "DocumentsOfAllItems", "Renditions" ], "type": "string", "x-enum-descriptions": [ "No file type selected.", "The master document file. Supports ResizeImage, ResizeImageWithClippingPath, CropImage, TranscodeVideo, CreatePackage and UpdateXmpMetadata target actions; an action added to an order target that isn't supported for this type is simply not applied to it.", "The master thumbnail. Does not support any target actions.", "All thumbnails. Does not support any target actions.", "The master preview. Does not support any target actions.", "All previews. Does not support any target actions.", "Additional files attached to the record. Supports ResizeImage, ResizeImageWithClippingPath and UpdateXmpMetadata target actions; an action added to an order target that isn't supported for this type is simply not applied to it.", "Documents of all items, for records that group multiple items. Does not support any target actions.", "Renditions of the record." ] }, "RecordsPublicationItemModel": { "title": "Records publication item model", "type": "object", "properties": { "isManual": { "type": [ "null", "boolean" ], "description": "Indicates whether this publication item was created manually." }, "pageNumber": { "type": "integer", "description": "Page number this publication item applies to.", "format": "int32" }, "targetFileVersionId": { "type": "string", "description": "Identifier of the target file version this publication item points to.", "format": "uuid" } }, "description": "A publication item linking a page of a file version to a target file version." }, "ReferenceRuleActionModel": { "title": "Reference rule action model", "type": "object", "properties": { "reference": { "type": "string", "description": "Reference to be executed" }, "index": { "type": "integer", "description": "Index of the action within the rule's action collection", "format": "int32" }, "actionType": { "description": "Type of action to be executed.", "$ref": "#/components/schemas/RuleActionDataType" }, "executionTime": { "description": "When the action should be executed.", "$ref": "#/components/schemas/RuleExecutionTime" } }, "description": "Model for Reference rule action" }, "ReferenceRuleActionNonResource": { "title": "Reference rule action non resource", "type": "object", "properties": { "reference": { "type": "string", "description": "Reference to be executed" }, "index": { "type": "integer", "description": "Index of a rule action in collection", "format": "int32" }, "actionType": { "description": "Data type of this rule action", "$ref": "#/components/schemas/RuleActionDataType" }, "executionTime": { "description": "Execution time of the rule action", "$ref": "#/components/schemas/RuleExecutionTime" } }, "description": "Representation of reference rule action" }, "ReferenceRuleConditionModel": { "title": "Reference rule condition model", "type": "object", "properties": { "reference": { "type": "string", "description": "Reference to be executed" }, "index": { "type": "integer", "description": "Index of the condition within the rule's condition collection", "format": "int32" }, "conditionType": { "description": "Type of condition to be evaluated.", "$ref": "#/components/schemas/RuleConditionDataType" } }, "description": "Model for Reference rule condition" }, "ReferenceRuleConditionNonResource": { "title": "Reference rule condition non resource", "type": "object", "properties": { "reference": { "type": "string", "description": "Reference to be executed" }, "index": { "type": "integer", "description": "Index of a rule condition in collection", "format": "int32" }, "conditionType": { "description": "Data type of this rule condition", "$ref": "#/components/schemas/RuleConditionDataType" } }, "description": "Representation of Reference Match rule" }, "ReferenceSettingDefinitionCreateCommand": { "title": "Reference setting definition create command", "type": "object", "properties": { "defaultValue": { "type": "string", "description": "Default value for this reference setting definition." }, "dataType": { "description": "Data type of the setting definition to create. Determines which additional properties apply.", "$ref": "#/components/schemas/SettingDefinitionType" }, "name": { "type": "string", "description": "Name of this setting definition." }, "categoryId": { "type": "string", "description": "Id of the setting category this setting definition belongs to.", "format": "uuid" }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelModel" }, "description": "Multi-language labels for the name of this setting definition." }, "allowSystemSetting": { "type": "boolean", "description": "When set, allows this setting to be configured at the system level." }, "allowUserSetting": { "type": "boolean", "description": "When set, allows this setting to be configured at the user level." }, "roleRequiredForChange": { "type": "string", "description": "Name of the role required to change settings of this definition." }, "userGroupSettingMode": { "enum": [ "None", "MaximumValue", "MinimumValue", "Manual", "FirstValue" ], "type": "string", "description": "Algorithm used to calculate the effective value for user group settings of this definition." }, "helpUrl": { "type": "string", "description": "URL to help documentation for this setting definition." }, "tag": { "type": "string", "description": "Free-form tag for this setting definition." } }, "description": "Creates a new reference setting definition." }, "ReferenceSettingDefinitionResource": { "title": "Reference setting definition resource", "type": "object", "properties": { "defaultValue": { "type": "string", "description": "Default value of the setting" }, "id": { "type": "string", "description": "Id of the setting definition", "format": "uuid" }, "helpUrl": { "type": "string", "description": "Help url for the setting definition" }, "userGroupSettingMode": { "enum": [ "None", "MaximumValue", "MinimumValue", "Manual", "FirstValue" ], "type": "string", "description": "UserGroupSettingMode for the setting definition" }, "categoryId": { "type": "string", "description": "Category Id for the setting definition", "format": "uuid" }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelNonResource" }, "description": "Collection of labels for the setting definition" }, "allowSystemSetting": { "type": "boolean", "description": "Indicates whether this setting can be configured at the system level." }, "allowUserSetting": { "type": "boolean", "description": "Indicates whether this setting can be configured per user." }, "roleRequiredForChange": { "type": "string", "description": "Role that needs to be changed" }, "name": { "type": "string", "description": "Name of the setting definition" }, "dataType": { "enum": [ "None", "Boolean", "Text", "Numeric", "DateTime", "Xml", "Role", "Reference", "EncryptedText", "DefSchema" ], "type": "string", "description": "Data type of this setting" }, "tag": { "type": "string", "description": "Tag for this setting containing extra information. Opt-in: returned only when requested. Include via a \"select-settingdefinition: Tag\" header." }, "modifiedOn": { "type": "string", "description": "Last modification datetime in UTC time.", "format": "date-time" }, "createdOn": { "type": "string", "description": "Creation datetime in UTC time.", "format": "date-time" }, "_links": { "type": "object", "properties": { "modifiedBy": { "description": "Relation to the user who last modified this settingdefinition.", "$ref": "#/components/schemas/Link" }, "createdBy": { "description": "Relation to the user who created this settingdefinition.", "$ref": "#/components/schemas/Link" }, "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "modifiedBy": { "description": "Relation to the user who last modified this settingdefinition. Embed via a \"select-referencesettingdefinition: modifiedBy\" header.", "$ref": "#/components/schemas/UserResource" }, "createdBy": { "description": "Relation to the user who created this settingdefinition. Embed via a \"select-referencesettingdefinition: createdBy\" header.", "$ref": "#/components/schemas/UserResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "Representation of a ReferenceSettingDefinition resource." }, "RefreshFileRecordActionParametersModel": { "title": "Refresh file record action parameters model", "type": "object", "description": "Parameters for the \"RefreshFileRecord\" maintenance job action. This action takes no parameters." }, "RefreshFilesRuleActionModel": { "title": "Refresh files rule action model", "type": "object", "properties": { "index": { "type": "integer", "description": "Index of the action within the rule's action collection", "format": "int32" }, "actionType": { "description": "Type of action to be executed.", "$ref": "#/components/schemas/RuleActionDataType" }, "executionTime": { "description": "When the action should be executed.", "$ref": "#/components/schemas/RuleExecutionTime" } }, "description": "Model for RefreshFiles rule action" }, "RefreshFilesRuleActionNonResource": { "title": "Refresh files rule action non resource", "type": "object", "properties": { "index": { "type": "integer", "description": "Index of a rule action in collection", "format": "int32" }, "actionType": { "description": "Data type of this rule action", "$ref": "#/components/schemas/RuleActionDataType" }, "executionTime": { "description": "Execution time of the rule action", "$ref": "#/components/schemas/RuleExecutionTime" } }, "description": "Representation of Refresh Files rule action" }, "RefreshOnAkamaiCdnActionParametersModel": { "title": "Refresh on akamai cdn action parameters model", "type": "object", "properties": { "renditionName": { "type": "string", "description": "Name of the rendition to refresh." }, "additionalFileId": { "type": "string", "description": "Id of the additional file to refresh, if refreshing an additional file.", "format": "uuid" }, "renditionId": { "type": "string", "description": "Id of the rendition to refresh, if refreshing a rendition.", "format": "uuid" } }, "description": "Parameters for the \"RefreshOnAkamaiCdn\" maintenance job action. At least one of AdditionalFileId or RenditionId is required (a runtime check, not enforced by this schema)." }, "RefreshOnPublicCdnActionParametersModel": { "title": "Refresh on public cdn action parameters model", "type": "object", "properties": { "renditionName": { "type": "string", "description": "Name of the rendition to refresh." }, "additionalFileId": { "type": "string", "description": "Id of the additional file to refresh, if refreshing an additional file.", "format": "uuid" }, "renditionId": { "type": "string", "description": "Id of the rendition to refresh, if refreshing a rendition.", "format": "uuid" } }, "description": "Parameters for the \"RefreshOnPublicCdn\" maintenance job action. At least one of AdditionalFileId or RenditionId is required (a runtime check, not enforced by this schema)." }, "RefreshUrlToPdfActionParametersModel": { "title": "Refresh url to pdf action parameters model", "type": "object", "description": "Parameters for the \"RefreshUrlToPdf\" maintenance job action. This action takes no parameters." }, "RegisteredFieldGroupNonResource": { "title": "Registered field group non resource", "type": "object", "properties": { "fieldGroupId": { "type": "string", "description": "The Id of the registered field group.", "format": "uuid" } }, "description": "Tracks registration of a field group to certain other ADAM objects" }, "RegisteredFieldNonResource": { "title": "Registered field non resource", "type": "object", "properties": { "fieldId": { "type": "string", "description": "Registered field id", "format": "uuid" } }, "description": "Tracks registration of a field to certain other ADAM objects" }, "ReleaseResource": { "title": "Release resource", "type": "object", "properties": { "releaseNumber": { "type": "string", "description": "The version number of the currently active DAM release." } }, "description": "The currently active DAM version." }, "RemoveFromFieldActionParametersModel": { "title": "Remove from field action parameters model", "type": "object", "properties": { "fieldId": { "type": "string", "description": "Id of the field to remove the value from.", "format": "uuid" }, "value": { "type": "string", "description": "Value to remove." }, "languageId": { "type": "string", "description": "Language of the field value, for multilingual fields.", "format": "uuid" } }, "description": "Parameters for the \"RemoveFromField\" maintenance job action." }, "RenditionCollectionResource": { "title": "Rendition collection resource", "type": "object", "properties": { "items": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/OriginalRenditionResource" }, { "$ref": "#/components/schemas/PresetRenditionResource" }, { "$ref": "#/components/schemas/TrimRenditionResource" }, { "$ref": "#/components/schemas/CropRenditionResource" }, { "$ref": "#/components/schemas/CustomRenditionResource" } ] }, "description": "A collection of resource items." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of a non-paged collection of renditions" }, "RenditionResource": { "title": "Rendition resource", "type": "object", "properties": { "id": { "type": "string", "description": "Identifier for the rendition", "format": "uuid" }, "uri": { "type": "string", "description": "Uri for this rendition Opt-in: returned only when requested. Include via a \"select-rendition: Uri\" header." }, "type": { "enum": [ "Original", "Preset", "Crop", "Trim", "Custom" ], "type": "string", "description": "Rendition type" }, "name": { "type": "string", "description": "Rendition name" }, "extension": { "type": "string", "description": "The extension of the rendition" }, "preview": { "type": "string", "description": "The preview of the rendition Opt-in: returned only when requested. Include via a \"select-rendition: Preview\" header." }, "publishedUri": { "type": "string", "description": "Shortcut property to the URI of the published public link of the rendition Opt-in: returned only when requested. Include via a \"select-rendition: PublishedUri\" header." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" }, "publicLinks": { "description": "Relation to the rendition public links.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "publicLinks": { "description": "Relation to the rendition public links. Embed via a \"select-rendition: publicLinks\" header.", "$ref": "#/components/schemas/PublicLinkCollectionResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "A generated derivative of a file version - e.g. a thumbnail, resized preview, or converted format - produced automatically by DAM's media processing pipeline." }, "ReplaceTextFieldActionParametersModel": { "title": "Replace text field action parameters model", "type": "object", "properties": { "fieldId": { "type": "string", "description": "Id of the field to replace text on.", "format": "uuid" }, "oldValue": { "type": "string", "description": "Text to search for and replace." }, "newValue": { "type": "string", "description": "Replacement text." }, "languageId": { "type": "string", "description": "Language of the field value, for multilingual fields.", "format": "uuid" } }, "description": "Parameters for the \"ReplaceTextField\" maintenance job action." }, "ReportingMaintenanceTargetResource": { "title": "Reporting maintenance target resource", "type": "object", "properties": { "objectId": { "type": "string", "description": "The Id of the entity this target represents.", "format": "uuid" }, "id": { "type": "string", "description": "The Id of this target.", "format": "uuid" }, "attempt": { "type": "integer", "description": "Value indicating how many times the maintenance manager has already tried to execute this target.", "format": "int32" }, "errorDetails": { "type": "string", "description": "Detailed information about the error that occurred if this target failed to execute successfully." }, "executionTime": { "type": "string", "description": "The amount of time needed to execute this target" }, "forceRetry": { "type": "boolean", "description": "Value indicating whether or not a new maintenance job will be created to retry this target after it finished its execution." }, "message": { "type": "string", "description": "The message that was set during the execution of this target" }, "status": { "description": "The status of this target.", "$ref": "#/components/schemas/MaintenanceTargetResourceStatus" }, "tag": { "type": "string", "description": "Custom data associated with this target, if any." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of a record maintenance target" }, "RequestVerificationTokenCommand": { "title": "Request verification token command", "type": "object", "properties": { "sharedDownloadLinkId": { "type": "string", "description": "Id of the shared download link to request verification for.", "format": "uuid" }, "email": { "type": "string", "description": "Email address of the recipient who should receive the verification token." } }, "description": "Requests a verification token for a shared download link and emails it to the given recipient." }, "ResolveContentTypeActionParametersModel": { "title": "Resolve content type action parameters model", "type": "object", "description": "Parameters for the \"ResolveContentType\" maintenance job action. This action takes no parameters." }, "ResolveContentTypeRuleActionModel": { "title": "Resolve content type rule action model", "type": "object", "properties": { "index": { "type": "integer", "description": "Index of the action within the rule's action collection", "format": "int32" }, "actionType": { "description": "Type of action to be executed.", "$ref": "#/components/schemas/RuleActionDataType" }, "executionTime": { "description": "When the action should be executed.", "$ref": "#/components/schemas/RuleExecutionTime" } }, "description": "Model for ResolveContentType rule action" }, "ResolveContentTypeRuleActionNonResource": { "title": "Resolve content type rule action non resource", "type": "object", "properties": { "index": { "type": "integer", "description": "Index of a rule action in collection", "format": "int32" }, "actionType": { "description": "Data type of this rule action", "$ref": "#/components/schemas/RuleActionDataType" }, "executionTime": { "description": "Execution time of the rule action", "$ref": "#/components/schemas/RuleExecutionTime" } }, "description": "Representation of resolve content type rule action" }, "RoleSettingDefinitionCreateCommand": { "title": "Role setting definition create command", "type": "object", "properties": { "dataType": { "description": "Data type of the setting definition to create. Determines which additional properties apply.", "$ref": "#/components/schemas/SettingDefinitionType" }, "name": { "type": "string", "description": "Name of this setting definition." }, "categoryId": { "type": "string", "description": "Id of the setting category this setting definition belongs to.", "format": "uuid" }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelModel" }, "description": "Multi-language labels for the name of this setting definition." }, "allowSystemSetting": { "type": "boolean", "description": "When set, allows this setting to be configured at the system level." }, "allowUserSetting": { "type": "boolean", "description": "When set, allows this setting to be configured at the user level." }, "roleRequiredForChange": { "type": "string", "description": "Name of the role required to change settings of this definition." }, "userGroupSettingMode": { "enum": [ "None", "MaximumValue", "MinimumValue", "Manual", "FirstValue" ], "type": "string", "description": "Algorithm used to calculate the effective value for user group settings of this definition." }, "helpUrl": { "type": "string", "description": "URL to help documentation for this setting definition." }, "tag": { "type": "string", "description": "Free-form tag for this setting definition." } }, "description": "Creates a new role setting definition." }, "RoleSettingDefinitionResource": { "title": "Role setting definition resource", "type": "object", "properties": { "id": { "type": "string", "description": "Id of the setting definition", "format": "uuid" }, "helpUrl": { "type": "string", "description": "Help url for the setting definition" }, "userGroupSettingMode": { "enum": [ "None", "MaximumValue", "MinimumValue", "Manual", "FirstValue" ], "type": "string", "description": "UserGroupSettingMode for the setting definition" }, "categoryId": { "type": "string", "description": "Category Id for the setting definition", "format": "uuid" }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelNonResource" }, "description": "Collection of labels for the setting definition" }, "allowSystemSetting": { "type": "boolean", "description": "Indicates whether this setting can be configured at the system level." }, "allowUserSetting": { "type": "boolean", "description": "Indicates whether this setting can be configured per user." }, "roleRequiredForChange": { "type": "string", "description": "Role that needs to be changed" }, "name": { "type": "string", "description": "Name of the setting definition" }, "dataType": { "enum": [ "None", "Boolean", "Text", "Numeric", "DateTime", "Xml", "Role", "Reference", "EncryptedText", "DefSchema" ], "type": "string", "description": "Data type of this setting" }, "tag": { "type": "string", "description": "Tag for this setting containing extra information. Opt-in: returned only when requested. Include via a \"select-settingdefinition: Tag\" header." }, "modifiedOn": { "type": "string", "description": "Last modification datetime in UTC time.", "format": "date-time" }, "createdOn": { "type": "string", "description": "Creation datetime in UTC time.", "format": "date-time" }, "_links": { "type": "object", "properties": { "modifiedBy": { "description": "Relation to the user who last modified this settingdefinition.", "$ref": "#/components/schemas/Link" }, "createdBy": { "description": "Relation to the user who created this settingdefinition.", "$ref": "#/components/schemas/Link" }, "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "modifiedBy": { "description": "Relation to the user who last modified this settingdefinition. Embed via a \"select-rolesettingdefinition: modifiedBy\" header.", "$ref": "#/components/schemas/UserResource" }, "createdBy": { "description": "Relation to the user who created this settingdefinition. Embed via a \"select-rolesettingdefinition: createdBy\" header.", "$ref": "#/components/schemas/UserResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "Representation of a RoleSettingDefinition resource." }, "RuleActionCollection": { "title": "Rule action collection", "type": "object", "properties": { "addOrUpdate": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/ReferenceRuleActionModel" }, { "$ref": "#/components/schemas/RefreshFilesRuleActionModel" }, { "$ref": "#/components/schemas/ApplyWatermarkOnMasterFileRuleActionModel" }, { "$ref": "#/components/schemas/ClassifyRecordRuleActionModel" }, { "$ref": "#/components/schemas/ScheduleResaveOfRecordRuleActionModel" }, { "$ref": "#/components/schemas/UnclassifyRecordRuleActionModel" }, { "$ref": "#/components/schemas/SetFieldValueRuleActionModel" }, { "$ref": "#/components/schemas/SendEmailRuleActionModel" }, { "$ref": "#/components/schemas/CreatePresetCropsRuleActionModel" }, { "$ref": "#/components/schemas/AprimoAIRuleActionModel" }, { "$ref": "#/components/schemas/AprimoAIUpdatePerformanceRuleActionModel" }, { "$ref": "#/components/schemas/CreateReviewFileRuleActionModel" }, { "$ref": "#/components/schemas/CreateRenditionsRuleActionModel" }, { "$ref": "#/components/schemas/CreatePublicUrisRuleActionModel" }, { "$ref": "#/components/schemas/DeletePublicUrisRuleActionModel" }, { "$ref": "#/components/schemas/ChangeContentTypeRuleActionModel" }, { "$ref": "#/components/schemas/ChangeRecordStatusRuleActionModel" }, { "$ref": "#/components/schemas/PredictiveMetadataRuleActionModel" }, { "$ref": "#/components/schemas/EnhancedCaptioningRuleActionModel" }, { "$ref": "#/components/schemas/ResolveContentTypeRuleActionModel" }, { "$ref": "#/components/schemas/RunTranslationAgentRuleActionModel" }, { "$ref": "#/components/schemas/CreateActivityRuleActionModel" }, { "$ref": "#/components/schemas/RunReviewAgentRuleActionModel" }, { "$ref": "#/components/schemas/RunTextMatchRuleActionModel" }, { "$ref": "#/components/schemas/VideoSummaryRuleActionModel" } ], "discriminator": { "propertyName": "actionType", "mapping": { "Reference": "#/components/schemas/ReferenceRuleActionModel", "RefreshFiles": "#/components/schemas/RefreshFilesRuleActionModel", "ApplyWatermarkOnMasterFile": "#/components/schemas/ApplyWatermarkOnMasterFileRuleActionModel", "ClassifyRecord": "#/components/schemas/ClassifyRecordRuleActionModel", "ScheduleResaveOfRecord": "#/components/schemas/ScheduleResaveOfRecordRuleActionModel", "UnclassifyRecord": "#/components/schemas/UnclassifyRecordRuleActionModel", "SetFieldValue": "#/components/schemas/SetFieldValueRuleActionModel", "SendEmail": "#/components/schemas/SendEmailRuleActionModel", "CreatePresetCrops": "#/components/schemas/CreatePresetCropsRuleActionModel", "AprimoAI": "#/components/schemas/AprimoAIRuleActionModel", "AprimoAIUpdatePerformance": "#/components/schemas/AprimoAIUpdatePerformanceRuleActionModel", "CreateReviewFile": "#/components/schemas/CreateReviewFileRuleActionModel", "CreateRenditions": "#/components/schemas/CreateRenditionsRuleActionModel", "CreatePublicLinks": "#/components/schemas/CreatePublicUrisRuleActionModel", "DeletePublicLinks": "#/components/schemas/DeletePublicUrisRuleActionModel", "ChangeContentType": "#/components/schemas/ChangeContentTypeRuleActionModel", "ChangeRecordStatus": "#/components/schemas/ChangeRecordStatusRuleActionModel", "PredictiveMetadata": "#/components/schemas/PredictiveMetadataRuleActionModel", "EnhancedCaptioning": "#/components/schemas/EnhancedCaptioningRuleActionModel", "ResolveContentType": "#/components/schemas/ResolveContentTypeRuleActionModel", "RunTranslationAgent": "#/components/schemas/RunTranslationAgentRuleActionModel", "CreateActivity": "#/components/schemas/CreateActivityRuleActionModel", "RunReviewAgent": "#/components/schemas/RunReviewAgentRuleActionModel", "RunTextMatch": "#/components/schemas/RunTextMatchRuleActionModel", "VideoSummary": "#/components/schemas/VideoSummaryRuleActionModel" } } }, "description": "Actions to be added or updated" }, "remove": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Indexes of the actions to be removed" } }, "description": "Collection of rule actions to add, update or remove" }, "RuleActionCollectionResource": { "title": "Rule action collection resource", "type": "object", "properties": { "items": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/ApplyWatermarkOnMasterFileNonResource" }, { "$ref": "#/components/schemas/AprimoAIRuleActionNonResource" }, { "$ref": "#/components/schemas/ChangeContentTypeRuleActionNonResource" }, { "$ref": "#/components/schemas/ChangeRecordStatusRuleActionNonResource" }, { "$ref": "#/components/schemas/ClassifyRecordRuleActionNonResource" }, { "$ref": "#/components/schemas/CreateActivityRuleActionNonResource" }, { "$ref": "#/components/schemas/CreatePresetCropsRuleActionNonResource" }, { "$ref": "#/components/schemas/CreatePublicUrisRuleActionNonResource" }, { "$ref": "#/components/schemas/CreateRenditionsRuleActionNonResource" }, { "$ref": "#/components/schemas/CreateReviewFileRuleActionNonResource" }, { "$ref": "#/components/schemas/DeletePublicUrisRuleActionNonResource" }, { "$ref": "#/components/schemas/EnhancedCaptioningRuleActionNonResource" }, { "$ref": "#/components/schemas/PredictiveMetadataRuleActionNonResource" }, { "$ref": "#/components/schemas/ReferenceRuleActionNonResource" }, { "$ref": "#/components/schemas/RefreshFilesRuleActionNonResource" }, { "$ref": "#/components/schemas/ResolveContentTypeRuleActionNonResource" }, { "$ref": "#/components/schemas/RunReviewAgentRuleActionNonResource" }, { "$ref": "#/components/schemas/RunTextMatchRuleActionNonResource" }, { "$ref": "#/components/schemas/RunTranslationAgentRuleActionNonResource" }, { "$ref": "#/components/schemas/ScheduleResaveOfRecordRuleActionNonResource" }, { "$ref": "#/components/schemas/SendEmailRuleActionNonResource" }, { "$ref": "#/components/schemas/SetFieldValueRuleActionNonResource" }, { "$ref": "#/components/schemas/UnclassifyRecordRuleActionNonResource" }, { "$ref": "#/components/schemas/VideoSummaryRuleActionNonResource" }, { "$ref": "#/components/schemas/AprimoAIUpdatePerformanceRuleActionNonResource" } ], "discriminator": { "propertyName": "actionType", "mapping": { "ApplyWatermarkOnMasterFile": "#/components/schemas/ApplyWatermarkOnMasterFileNonResource", "AprimoAI": "#/components/schemas/AprimoAIRuleActionNonResource", "ChangeContentType": "#/components/schemas/ChangeContentTypeRuleActionNonResource", "ChangeRecordStatus": "#/components/schemas/ChangeRecordStatusRuleActionNonResource", "ClassifyRecord": "#/components/schemas/ClassifyRecordRuleActionNonResource", "CreateActivity": "#/components/schemas/CreateActivityRuleActionNonResource", "CreatePresetCrops": "#/components/schemas/CreatePresetCropsRuleActionNonResource", "CreatePublicLinks": "#/components/schemas/CreatePublicUrisRuleActionNonResource", "CreateRenditions": "#/components/schemas/CreateRenditionsRuleActionNonResource", "CreateReviewFile": "#/components/schemas/CreateReviewFileRuleActionNonResource", "DeletePublicLinks": "#/components/schemas/DeletePublicUrisRuleActionNonResource", "EnhancedCaptioning": "#/components/schemas/EnhancedCaptioningRuleActionNonResource", "PredictiveMetadata": "#/components/schemas/PredictiveMetadataRuleActionNonResource", "Reference": "#/components/schemas/ReferenceRuleActionNonResource", "RefreshFiles": "#/components/schemas/RefreshFilesRuleActionNonResource", "ResolveContentType": "#/components/schemas/ResolveContentTypeRuleActionNonResource", "RunReviewAgent": "#/components/schemas/RunReviewAgentRuleActionNonResource", "RunTextMatch": "#/components/schemas/RunTextMatchRuleActionNonResource", "RunTranslationAgent": "#/components/schemas/RunTranslationAgentRuleActionNonResource", "ScheduleResaveOfRecord": "#/components/schemas/ScheduleResaveOfRecordRuleActionNonResource", "SendEmail": "#/components/schemas/SendEmailRuleActionNonResource", "SetFieldValue": "#/components/schemas/SetFieldValueRuleActionNonResource", "UnclassifyRecord": "#/components/schemas/UnclassifyRecordRuleActionNonResource", "VideoSummary": "#/components/schemas/VideoSummaryRuleActionNonResource", "AprimoAIUpdatePerformance": "#/components/schemas/AprimoAIUpdatePerformanceRuleActionNonResource" } } }, "description": "A collection of non-resource items." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of a collection of rule actions" }, "RuleActionDataType": { "title": "Rule action data type", "enum": [ "Reference", "RefreshFiles", "ApplyWatermarkOnMasterFile", "ClassifyRecord", "ScheduleResaveOfRecord", "UnclassifyRecord", "SetFieldValue", "SendEmail", "CreatePresetCrops", "AprimoAI", "AprimoAIUpdatePerformance", "CreateReviewFile", "CreateRenditions", "CreatePublicLinks", "DeletePublicLinks", "ChangeContentType", "ChangeRecordStatus", "PredictiveMetadata", "EnhancedCaptioning", "ResolveContentType", "RunTranslationAgent", "CreateActivity", "RunReviewAgent", "RunTextMatch", "VideoSummary" ], "type": "string", "x-enum-descriptions": [ "Executes another rule by reference", "Refreshes the files of the record", "Applies a watermark on the master file", "Classifies the record", "Schedules a resave of the record", "Unclassifies the record", "Value of a field", "Sends an email", "Creates preset crops", "Executes Aprimo AI", "Updates the performance of the Aprimo AI extraction", "Creates a review file", "Creates renditions", "Creates public links", "Deletes public links", "Changes the content type", "Changes the record status", "Executes predictive metadata", "Executes enhanced captioning", "Resolves the content type", "Executes a translation agent", "Creates a scheduled activity", "Runs a review agent", "Runs a text match", "Generates a video summary" ] }, "RuleConditionCollection": { "title": "Rule condition collection", "type": "object", "properties": { "addOrUpdate": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/ReferenceRuleConditionModel" }, { "$ref": "#/components/schemas/ObjectCreatedRuleConditionModel" }, { "$ref": "#/components/schemas/ObjectCreatedOrChangedRuleConditionModel" }, { "$ref": "#/components/schemas/ObjectDeletedRuleConditionModel" }, { "$ref": "#/components/schemas/ClassificationLinkedRuleConditionModel" }, { "$ref": "#/components/schemas/ClassificationUnlinkedRuleConditionModel" }, { "$ref": "#/components/schemas/ClassifiedInRuleConditionModel" }, { "$ref": "#/components/schemas/CurrentlyLoggedOnUserRuleConditionModel" }, { "$ref": "#/components/schemas/FileAddedRuleConditionModel" }, { "$ref": "#/components/schemas/FileProcessingCompletedRuleConditionModel" }, { "$ref": "#/components/schemas/MovieAddedWithoutMoviePreviewRuleConditionModel" }, { "$ref": "#/components/schemas/ObjectChangedRuleConditionModel" }, { "$ref": "#/components/schemas/CompareFieldValueRuleConditionModel" }, { "$ref": "#/components/schemas/HasFieldValueChangedRuleConditionModel" }, { "$ref": "#/components/schemas/ContentTypeChangedRuleConditionModel" }, { "$ref": "#/components/schemas/ContentTypeIsRuleConditionModel" }, { "$ref": "#/components/schemas/ContentTypeChangedToRuleConditionModel" }, { "$ref": "#/components/schemas/RecordStatusChangedRuleConditionModel" }, { "$ref": "#/components/schemas/RecordStatusIsRuleConditionModel" }, { "$ref": "#/components/schemas/RecordStatusChangedToRuleConditionModel" }, { "$ref": "#/components/schemas/MasterPreviewExistsRuleConditionModel" }, { "$ref": "#/components/schemas/MasterPreviewChangedRuleConditionModel" }, { "$ref": "#/components/schemas/MultilingualFieldValuesChangedRuleConditionModel" } ], "discriminator": { "propertyName": "conditionType", "mapping": { "Reference": "#/components/schemas/ReferenceRuleConditionModel", "ObjectCreated": "#/components/schemas/ObjectCreatedRuleConditionModel", "ObjectCreatedOrChanged": "#/components/schemas/ObjectCreatedOrChangedRuleConditionModel", "ObjectDeleted": "#/components/schemas/ObjectDeletedRuleConditionModel", "ClassificationLinked": "#/components/schemas/ClassificationLinkedRuleConditionModel", "ClassificationUnlinked": "#/components/schemas/ClassificationUnlinkedRuleConditionModel", "ClassifiedIn": "#/components/schemas/ClassifiedInRuleConditionModel", "CurrentlyLoggedOnUser": "#/components/schemas/CurrentlyLoggedOnUserRuleConditionModel", "FileAdded": "#/components/schemas/FileAddedRuleConditionModel", "FileProcessingCompleted": "#/components/schemas/FileProcessingCompletedRuleConditionModel", "MovieAddedWithoutMoviePreview": "#/components/schemas/MovieAddedWithoutMoviePreviewRuleConditionModel", "ObjectChanged": "#/components/schemas/ObjectChangedRuleConditionModel", "CompareFieldValue": "#/components/schemas/CompareFieldValueRuleConditionModel", "HasFieldValueChanged": "#/components/schemas/HasFieldValueChangedRuleConditionModel", "ContentTypeChanged": "#/components/schemas/ContentTypeChangedRuleConditionModel", "ContentTypeIs": "#/components/schemas/ContentTypeIsRuleConditionModel", "ContentTypeSetTo": "#/components/schemas/ContentTypeChangedToRuleConditionModel", "RecordStatusChanged": "#/components/schemas/RecordStatusChangedRuleConditionModel", "RecordStatusIs": "#/components/schemas/RecordStatusIsRuleConditionModel", "RecordStatusSetTo": "#/components/schemas/RecordStatusChangedToRuleConditionModel", "MasterPreviewExists": "#/components/schemas/MasterPreviewExistsRuleConditionModel", "MasterPreviewChanged": "#/components/schemas/MasterPreviewChangedRuleConditionModel", "MultilingualFieldValuesChanged": "#/components/schemas/MultilingualFieldValuesChangedRuleConditionModel" } } }, "description": "Conditions to be added or updated" }, "remove": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Indexes of the conditions to be removed" } }, "description": "Collection of rule conditions to add, update or remove" }, "RuleConditionCollectionResource": { "title": "Rule condition collection resource", "type": "object", "properties": { "items": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/ClassificationLinkedRuleConditionNonResource" }, { "$ref": "#/components/schemas/ClassificationUnlinkedRuleConditionNonResource" }, { "$ref": "#/components/schemas/ClassifiedInRuleConditionNonResource" }, { "$ref": "#/components/schemas/CompareFieldValueRuleConditionNonResource" }, { "$ref": "#/components/schemas/ContentTypeChangedRuleConditionNonResource" }, { "$ref": "#/components/schemas/ContentTypeChangedToRuleConditionNonResource" }, { "$ref": "#/components/schemas/ContentTypeIsRuleConditionNonResource" }, { "$ref": "#/components/schemas/CurrentlyLoggedOnUserRuleConditionNonResource" }, { "$ref": "#/components/schemas/FileAddedRuleConditionNonResource" }, { "$ref": "#/components/schemas/FileProcessingCompletedRuleConditionNonResource" }, { "$ref": "#/components/schemas/HasFieldValueChangedRuleConditionNonResource" }, { "$ref": "#/components/schemas/MasterPreviewChangedRuleConditionNonResource" }, { "$ref": "#/components/schemas/MasterPreviewExistsRuleConditionNonResource" }, { "$ref": "#/components/schemas/MovieAddedWithoutMoviePreviewRuleConditionNonResource" }, { "$ref": "#/components/schemas/MultilingualFieldValuesChangedRuleConditionNonResource" }, { "$ref": "#/components/schemas/ObjectChangedRuleConditionNonResource" }, { "$ref": "#/components/schemas/ObjectCreatedOrChangedRuleConditionNonResource" }, { "$ref": "#/components/schemas/ObjectCreatedRuleConditionNonResource" }, { "$ref": "#/components/schemas/ObjectDeletedRuleConditionNonResource" }, { "$ref": "#/components/schemas/RecordStatusChangedRuleConditionNonResource" }, { "$ref": "#/components/schemas/RecordStatusChangedToRuleConditionNonResource" }, { "$ref": "#/components/schemas/RecordStatusIsRuleConditionNonResource" }, { "$ref": "#/components/schemas/ReferenceRuleConditionNonResource" } ], "discriminator": { "propertyName": "conditionType", "mapping": { "ClassificationLinked": "#/components/schemas/ClassificationLinkedRuleConditionNonResource", "ClassificationUnlinked": "#/components/schemas/ClassificationUnlinkedRuleConditionNonResource", "ClassifiedIn": "#/components/schemas/ClassifiedInRuleConditionNonResource", "CompareFieldValue": "#/components/schemas/CompareFieldValueRuleConditionNonResource", "ContentTypeChanged": "#/components/schemas/ContentTypeChangedRuleConditionNonResource", "ContentTypeSetTo": "#/components/schemas/ContentTypeChangedToRuleConditionNonResource", "ContentTypeIs": "#/components/schemas/ContentTypeIsRuleConditionNonResource", "CurrentlyLoggedOnUser": "#/components/schemas/CurrentlyLoggedOnUserRuleConditionNonResource", "FileAdded": "#/components/schemas/FileAddedRuleConditionNonResource", "FileProcessingCompleted": "#/components/schemas/FileProcessingCompletedRuleConditionNonResource", "HasFieldValueChanged": "#/components/schemas/HasFieldValueChangedRuleConditionNonResource", "MasterPreviewChanged": "#/components/schemas/MasterPreviewChangedRuleConditionNonResource", "MasterPreviewExists": "#/components/schemas/MasterPreviewExistsRuleConditionNonResource", "MovieAddedWithoutMoviePreview": "#/components/schemas/MovieAddedWithoutMoviePreviewRuleConditionNonResource", "MultilingualFieldValuesChanged": "#/components/schemas/MultilingualFieldValuesChangedRuleConditionNonResource", "ObjectChanged": "#/components/schemas/ObjectChangedRuleConditionNonResource", "ObjectCreatedOrChanged": "#/components/schemas/ObjectCreatedOrChangedRuleConditionNonResource", "ObjectCreated": "#/components/schemas/ObjectCreatedRuleConditionNonResource", "ObjectDeleted": "#/components/schemas/ObjectDeletedRuleConditionNonResource", "RecordStatusChanged": "#/components/schemas/RecordStatusChangedRuleConditionNonResource", "RecordStatusSetTo": "#/components/schemas/RecordStatusChangedToRuleConditionNonResource", "RecordStatusIs": "#/components/schemas/RecordStatusIsRuleConditionNonResource", "Reference": "#/components/schemas/ReferenceRuleConditionNonResource" } } }, "description": "A collection of non-resource items." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of a collection of rule conditions" }, "RuleConditionDataType": { "title": "Rule condition data type", "enum": [ "ClassificationLinked", "ClassificationUnlinked", "ClassifiedIn", "CurrentlyLoggedOnUser", "FileAdded", "MovieAddedWithoutMoviePreview", "ObjectChanged", "ObjectCreatedOrChanged", "ObjectCreated", "ObjectDeleted", "Reference", "CompareFieldValue", "HasFieldValueChanged", "ContentTypeChanged", "ContentTypeIs", "ContentTypeSetTo", "RecordStatusChanged", "RecordStatusIs", "RecordStatusSetTo", "MasterPreviewExists", "MasterPreviewChanged", "FileProcessingCompleted", "MultilingualFieldValuesChanged" ], "type": "string", "x-enum-descriptions": [ "Evaluates another rule by reference", "A classification is unlinked", "The record is classified in a given classification", "The record was created or changed by the currently logged on user", "A file was added to the record", "A movie was added without a movie preview", "The object was changed", "The object was created or changed", "The object was created", "The object was deleted", "Evaluates another condition by reference", "Compares the value of a field", "The value of a field has changed", "The content type has changed", "The content type is a given value", "The content type was set to a given value", "The record status has changed", "The record status is a given value", "The record status was set to a given value", "The master preview exists", "The master preview has changed", "File processing has completed", "The value of a multilingual field has changed" ] }, "RuleCreateCommand": { "title": "Rule create command", "type": "object", "properties": { "enabled": { "type": "boolean", "description": "If true, the rule is enabled" }, "target": { "type": "string", "description": "Type of entity the rule applies to (e.g. Record, Classification, Collection)." }, "trigger": { "type": "string", "description": "Event that triggers the rule: when the target is saved or deleted, or on a daily schedule." }, "name": { "type": "string", "description": "Name of the rule" }, "tag": { "type": "string", "description": "Tag of the rule" }, "includeDraftRecords": { "type": "boolean", "description": "If true, draft records are included" }, "isInternal": { "type": "boolean", "description": "If true, the rule is internal" }, "conditions": { "description": "Conditions to be added, updated or removed", "$ref": "#/components/schemas/RuleConditionCollection" }, "actions": { "description": "Actions to be added, updated or removed", "$ref": "#/components/schemas/RuleActionCollection" } }, "description": "Command to create a rule" }, "RuleEditCommand": { "title": "Rule edit command", "type": "object", "properties": { "enabled": { "type": "boolean", "description": "If true, the rule is enabled" }, "target": { "type": "string", "description": "Type of entity the rule applies to (e.g. Record, Classification, Collection)." }, "trigger": { "type": "string", "description": "Event that triggers the rule: when the target is saved or deleted, or on a daily schedule." }, "name": { "type": "string", "description": "Name of the rule" }, "tag": { "type": "string", "description": "Tag of the rule" }, "includeDraftRecords": { "type": "boolean", "description": "If true, draft records are included" }, "isInternal": { "type": "boolean", "description": "If true, the rule is internal" }, "conditions": { "description": "Conditions to be added, updated or removed", "$ref": "#/components/schemas/RuleConditionCollection" }, "actions": { "description": "Actions to be added, updated or removed", "$ref": "#/components/schemas/RuleActionCollection" } }, "description": "Command to edit a rule" }, "RuleExecutionTime": { "title": "Rule execution time", "enum": [ "Delayed", "Immediately" ], "type": "string", "x-enum-descriptions": [ "The action is executed later, in a background job", "The action is executed immediately" ] }, "RuleMaintenanceTargetResource": { "title": "Rule maintenance target resource", "type": "object", "properties": { "objectId": { "type": "string", "description": "The Id of the entity to execute rule on.", "format": "uuid" }, "ruleTarget": { "enum": [ "None", "SettingDefinition", "FieldDefinition", "IndexerTask", "Translation", "SettingCategory", "UserGroup", "Watermark", "FieldGroup", "Basket", "User", "Classification", "Record", "Language", "FileType", "Organization", "Site", "FileStore", "SavedView" ], "type": "string", "description": "The RuleTarget of the entity to execute rule on." }, "id": { "type": "string", "description": "The Id of this target.", "format": "uuid" }, "attempt": { "type": "integer", "description": "Value indicating how many times the maintenance manager has already tried to execute this target.", "format": "int32" }, "errorDetails": { "type": "string", "description": "Detailed information about the error that occurred if this target failed to execute successfully." }, "executionTime": { "type": "string", "description": "The amount of time needed to execute this target" }, "forceRetry": { "type": "boolean", "description": "Value indicating whether or not a new maintenance job will be created to retry this target after it finished its execution." }, "message": { "type": "string", "description": "The message that was set during the execution of this target" }, "status": { "description": "The status of this target.", "$ref": "#/components/schemas/MaintenanceTargetResourceStatus" }, "tag": { "type": "string", "description": "Custom data associated with this target, if any." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of a record maintenance target" }, "RulePagedCollectionResource": { "title": "Rule paged collection resource", "type": "object", "properties": { "pageNumber": { "type": [ "null", "integer" ], "description": "The current page of this paged collection.", "format": "int32" }, "pageSize": { "type": [ "null", "integer" ], "description": "The current page size of this paged collection.", "format": "int32" }, "skip": { "type": [ "null", "integer" ], "description": "The current skip size of this paged collection.", "format": "int32" }, "take": { "type": [ "null", "integer" ], "description": "The current take size of this paged collection.", "format": "int32" }, "totalCount": { "type": "integer", "description": "The total count of items in this paged collection, not just on the current page.", "format": "int64" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/RuleResource" }, "description": "One page of this paged collection, which is a subcollection of the complete collection." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" }, "first": { "description": "A link to the first page of this paged collection.", "$ref": "#/components/schemas/Link" }, "prev": { "description": "A link to the previous page of this paged collection.", "$ref": "#/components/schemas/Link" }, "next": { "description": "A link to the next page of this paged collection.", "$ref": "#/components/schemas/Link" }, "last": { "description": "A link to the last page of this paged collection.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of a paged collection of rules" }, "RuleResource": { "title": "Rule resource", "type": "object", "properties": { "id": { "type": "string", "description": "Id of this rule.", "format": "uuid" }, "enabled": { "type": "boolean", "description": "Is rule enabled" }, "target": { "description": "Object type that triggers this rule.", "$ref": "#/components/schemas/RuleTarget" }, "trigger": { "description": "Trigger of this rule.", "$ref": "#/components/schemas/RuleTrigger" }, "name": { "type": "string", "description": "Name of this rule." }, "tag": { "type": "string", "description": "Value of the Tag for this object. The value of this property has to be valid XML code. Opt-in: returned only when requested. Include via a \"select-rule: Tag\" header." }, "version": { "type": "integer", "description": "Version of this rule.", "format": "int32" }, "includeDraftRecords": { "type": [ "null", "boolean" ], "description": "Indicates whether this rule can be executed on draft records. Applied and visible in response only in case 'target' has value 'record'" }, "expression": { "type": "string", "description": "Search expression based on conditions that are available for parsing. Applied and visible in response only in case 'trigger' has value 'daily'" }, "isInternal": { "type": [ "null", "boolean" ], "description": "Internal rules can only be edited by operators." }, "modifiedOn": { "type": "string", "description": "Last modification datetime in UTC time.", "format": "date-time" }, "createdOn": { "type": "string", "description": "Creation datetime in UTC time.", "format": "date-time" }, "_links": { "type": "object", "properties": { "conditions": { "description": "Relation to the conditions of this rule.", "$ref": "#/components/schemas/Link" }, "actions": { "description": "Relation to the action of this rule.", "$ref": "#/components/schemas/Link" }, "modifiedBy": { "description": "Relation to the user who last modified this rule.", "$ref": "#/components/schemas/Link" }, "createdBy": { "description": "Relation to the user who created this rule.", "$ref": "#/components/schemas/Link" }, "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "conditions": { "description": "Relation to the conditions of this rule. Embed via a \"select-rule: conditions\" header.", "$ref": "#/components/schemas/RuleConditionCollectionResource" }, "actions": { "description": "Relation to the action of this rule. Embed via a \"select-rule: actions\" header.", "$ref": "#/components/schemas/RuleActionCollectionResource" }, "modifiedBy": { "description": "Relation to the user who last modified this rule. Embed via a \"select-rule: modifiedBy\" header.", "$ref": "#/components/schemas/UserResource" }, "createdBy": { "description": "Relation to the user who created this rule. Embed via a \"select-rule: createdBy\" header.", "$ref": "#/components/schemas/UserResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "An automation that runs a set of actions when its trigger fires and its conditions match (e.g. on record creation) - used to automate DAM workflows such as classification, notification, or field population." }, "RuleTarget": { "title": "Rule target", "enum": [ "SettingDefinition", "FieldDefinition", "IndexerTask", "Translation", "SettingCategory", "UserGroup", "Watermark", "FieldGroup", "Collection", "User", "Classification", "Record", "Language", "FileType", "Organization", "Site", "Publication", "Subscription", "FileStore", "SavedView" ], "type": "string" }, "RuleTrigger": { "title": "Rule trigger", "enum": [ "WhenSavedOrDeleted", "Daily" ], "type": "string", "x-enum-descriptions": [ "The rule is triggered when the target is saved or deleted", "The rule is triggered daily" ] }, "RunReviewAgentActionParametersModel": { "title": "Run review agent action parameters model", "type": "object", "properties": { "reviewAgentId": { "type": "string", "description": "Id of the review agent to run.", "format": "uuid" } }, "description": "Parameters for the \"RunReviewAgent\" maintenance job action." }, "RunReviewAgentRuleActionModel": { "title": "Run review agent rule action model", "type": "object", "properties": { "contentCoachId": { "type": [ "null", "integer" ], "description": "Id of the ContentCoach-backed review agent to run. Exactly one of ContentCoachId or BuiltInAgentId must be set.", "format": "int32" }, "builtInAgentId": { "type": "string", "description": "Id of the built-in review agent to run. Exactly one of ContentCoachId or BuiltInAgentId must be set." }, "index": { "type": "integer", "description": "Index of the action within the rule's action collection", "format": "int32" }, "actionType": { "description": "Type of action to be executed.", "$ref": "#/components/schemas/RuleActionDataType" }, "executionTime": { "description": "When the action should be executed.", "$ref": "#/components/schemas/RuleExecutionTime" } }, "description": "Model for RunReviewAgent rule action" }, "RunReviewAgentRuleActionNonResource": { "title": "Run review agent rule action non resource", "type": "object", "properties": { "contentCoachId": { "type": [ "null", "integer" ], "description": "Id of the ContentCoach-backed review agent to run, if configured.", "format": "int32" }, "builtInAgentId": { "type": "string", "description": "Id of the built-in review agent to run, if configured." }, "index": { "type": "integer", "description": "Index of a rule action in collection", "format": "int32" }, "actionType": { "description": "Data type of this rule action", "$ref": "#/components/schemas/RuleActionDataType" }, "executionTime": { "description": "Execution time of the rule action", "$ref": "#/components/schemas/RuleExecutionTime" } }, "description": "Representation of Run Review Agent rule action" }, "RunTextMatchRuleActionModel": { "title": "Run text match rule action model", "type": "object", "properties": { "index": { "type": "integer", "description": "Index of the action within the rule's action collection", "format": "int32" }, "actionType": { "description": "Type of action to be executed.", "$ref": "#/components/schemas/RuleActionDataType" }, "executionTime": { "description": "When the action should be executed.", "$ref": "#/components/schemas/RuleExecutionTime" } }, "description": "Model for RunTextMatch rule action" }, "RunTextMatchRuleActionNonResource": { "title": "Run text match rule action non resource", "type": "object", "properties": { "index": { "type": "integer", "description": "Index of a rule action in collection", "format": "int32" }, "actionType": { "description": "Data type of this rule action", "$ref": "#/components/schemas/RuleActionDataType" }, "executionTime": { "description": "Execution time of the rule action", "$ref": "#/components/schemas/RuleExecutionTime" } }, "description": "Representation of Run Text Match rule action" }, "RunTranslationAgentRuleActionModel": { "title": "Run translation agent rule action model", "type": "object", "properties": { "fieldDefinitionIds": { "type": "array", "items": { "type": [ "null", "string" ], "format": "uuid" }, "description": "Ids of the multilingual field definitions to translate" }, "fieldScope": { "description": "Which fields to translate: only the ones that changed, or all selected fields", "$ref": "#/components/schemas/TranslationAgentFieldScope" }, "index": { "type": "integer", "description": "Index of the action within the rule's action collection", "format": "int32" }, "actionType": { "description": "Type of action to be executed.", "$ref": "#/components/schemas/RuleActionDataType" }, "executionTime": { "description": "When the action should be executed.", "$ref": "#/components/schemas/RuleExecutionTime" } }, "description": "Model for RunTranslationAgent rule action" }, "RunTranslationAgentRuleActionNonResource": { "title": "Run translation agent rule action non resource", "type": "object", "properties": { "fieldDefinitionIds": { "type": "array", "items": { "type": [ "null", "string" ], "format": "uuid" }, "description": "Ids of the multilingual fields to translate" }, "fieldScope": { "description": "Controls whether only changed fields or all selected fields are translated", "$ref": "#/components/schemas/TranslationAgentFieldScope" }, "index": { "type": "integer", "description": "Index of a rule action in collection", "format": "int32" }, "actionType": { "description": "Data type of this rule action", "$ref": "#/components/schemas/RuleActionDataType" }, "executionTime": { "description": "Execution time of the rule action", "$ref": "#/components/schemas/RuleExecutionTime" } }, "description": "Representation of Run Translation Agent rule action" }, "SanitizeFieldHtmlCommand": { "title": "Sanitize field html command", "type": "object", "properties": { "value": { "type": "string", "description": "HTML content to sanitize." } }, "description": "Sanitizes HTML content in a field value, removing disallowed tags, attributes, and styles." }, "SanitizeFieldHtmlResultNonResource": { "title": "Sanitize field html result non resource", "type": "object", "properties": { "dirty": { "type": "boolean", "description": "Whether the value was changed during sanitization." }, "cleanValue": { "type": "string", "description": "Sanitized HTML content." }, "removedTags": { "type": "array", "items": { "type": "string" }, "description": "Tags that were removed during sanitization." }, "removedAttributes": { "type": "array", "items": { "type": "string" }, "description": "Attributes that were removed during sanitization." }, "removedStyles": { "type": "array", "items": { "type": "string" }, "description": "Styles that were removed during sanitization." }, "removedAtRules": { "type": "array", "items": { "type": "string" }, "description": "At-rules that were removed during sanitization." }, "removedComments": { "type": "array", "items": { "type": "string" }, "description": "Comments that were removed during sanitization." }, "removedCssClasses": { "type": "array", "items": { "type": "string" }, "description": "CSS classes that were removed during sanitization." }, "filteredUrls": { "type": "array", "items": { "type": "string" }, "description": "Urls that were filtered out during sanitization." } }, "description": "The result of sanitizing an HTML field value, stripping any markup not on the allowed tag/attribute list." }, "ScheduleResaveOfRecordRuleActionModel": { "title": "Schedule resave of record rule action model", "type": "object", "properties": { "fieldDefinitionId": { "type": [ "null", "string" ], "description": "Id of the field definition to resave", "format": "uuid" }, "index": { "type": "integer", "description": "Index of the action within the rule's action collection", "format": "int32" }, "actionType": { "description": "Type of action to be executed.", "$ref": "#/components/schemas/RuleActionDataType" }, "executionTime": { "description": "When the action should be executed.", "$ref": "#/components/schemas/RuleExecutionTime" } }, "description": "Model for ScheduleResaveOfRecord rule action" }, "ScheduleResaveOfRecordRuleActionNonResource": { "title": "Schedule resave of record rule action non resource", "type": "object", "properties": { "fieldDefinitionId": { "type": [ "null", "string" ], "description": "Id of the datetime field containing the resave date", "format": "uuid" }, "index": { "type": "integer", "description": "Index of a rule action in collection", "format": "int32" }, "actionType": { "description": "Data type of this rule action", "$ref": "#/components/schemas/RuleActionDataType" }, "executionTime": { "description": "Execution time of the rule action", "$ref": "#/components/schemas/RuleExecutionTime" } }, "description": "Representation of the Schedule Resave Of Record rule action, which schedules the record to be resaved on the date held in the specified datetime field." }, "SearchExpressionModel": { "title": "Search expression model", "type": "object", "properties": { "disabledKeywords": { "type": "array", "items": { "$ref": "#/components/schemas/DisabledKeyword" }, "description": "Keywords disabled from special search syntax parsing." }, "supportWildcards": { "type": [ "null", "boolean" ], "description": "Value indicating whether wildcard characters are supported." }, "defaultLogicalOperator": { "description": "Default operator used to combine terms.", "$ref": "#/components/schemas/BooleanOperatorType" }, "languages": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "List of language identifiers to search within." }, "expression": { "type": "string", "description": "Raw search expression string, optionally containing named or unnamed parameters. You can specify either expression or subExpressions, but not both." }, "parameters": { "type": "array", "items": { "type": "string" }, "description": "Positional parameter values referenced from the expression." }, "namedParameters": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Named parameter values referenced from the expression, keyed by parameter name." }, "subExpressions": { "type": "array", "items": { "$ref": "#/components/schemas/SearchExpressionModel" }, "description": "Sub-expressions combined with this one via logical AND - only records matching all sub-expressions are returned. You can specify either expression or subExpressions, but not both." } }, "description": "Represents a search expression used to filter search results." }, "SearchIndexResource": { "title": "Search index resource", "type": "object", "properties": { "rebuildRequired": { "type": "boolean", "description": "Returns true if the search index needs to be rebuilt." }, "rebuildScheduled": { "type": "boolean", "description": "Returns true if the search is indexing." }, "indexedRecords": { "type": "integer", "description": "Provides a number of indexed records.", "format": "int64" }, "indexedClassifications": { "type": "integer", "description": "Provides a number of indexed classifications.", "format": "int64" }, "pendingChanges": { "type": "integer", "description": "Provides a number of pending changes.", "format": "int32" }, "lastChangeId": { "type": "integer", "description": "Provides the last change ID.", "format": "int64" }, "lastChangeDateTime": { "type": [ "null", "string" ], "description": "Provides the last change date and time.", "format": "date-time" }, "lastIndexRebuild": { "type": [ "null", "string" ], "description": "Provides a date and time when the last index built on.", "format": "date-time" }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Status of the tenant's record/classification search index - rebuild progress, indexed counts, and pending changes - used to monitor and trigger reindexing." }, "SearchResponseResource": { "title": "Search response resource", "type": "object", "properties": { "facets": { "type": "array", "items": { "$ref": "#/components/schemas/FacetNonResource" }, "description": "The collection of facets. Facet values with a count of 0 are omitted, even if they were directly requested, e.g. as explicitValues - if you need to display facet values with a count of 0, keep track of them on your side." }, "truncatedFacets": { "type": "array", "items": { "type": "string" }, "description": "Names of facets that were dropped from this response because more than 12 facets were requested - the search engine only computes the first 12 facets per request." }, "nextCursor": { "type": [ "null", "string" ], "description": "Opaque cursor for the next page. Pass back as cursor in the next request to continue from exactly this position at constant cost per page, regardless of depth. Null when this is the last page or the result set is empty." }, "pageNumber": { "type": [ "null", "integer" ], "description": "The current page of this paged collection.", "format": "int32" }, "pageSize": { "type": [ "null", "integer" ], "description": "The current page size of this paged collection.", "format": "int32" }, "skip": { "type": [ "null", "integer" ], "description": "The current skip size of this paged collection.", "format": "int32" }, "take": { "type": [ "null", "integer" ], "description": "The current take size of this paged collection.", "format": "int32" }, "totalCount": { "type": "integer", "description": "The total count of items in this paged collection, not just on the current page.", "format": "int64" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/RecordResource" }, "description": "One page of this paged collection, which is a subcollection of the complete collection." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" }, "first": { "description": "A link to the first page of this paged collection.", "$ref": "#/components/schemas/Link" }, "prev": { "description": "A link to the previous page of this paged collection.", "$ref": "#/components/schemas/Link" }, "next": { "description": "A link to the next page of this paged collection.", "$ref": "#/components/schemas/Link" }, "last": { "description": "A link to the last page of this paged collection.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Represents a complete search response, including a paged collection of hits and optional facet information. Searching is done in 2 steps: first ElasticSearch is queried to get a list of matching IDs, then those IDs are used to query the Aprimo DAM database. Because of this, totalCount is an approximation and might not match the number of returned search results, and facet counts are also approximate." }, "SendEmailRuleActionModel": { "title": "Send email rule action model", "type": "object", "properties": { "targetType": { "enum": [ "SubscribersList", "Reference" ], "type": "string", "description": "Target of the email." }, "reference": { "type": "string", "description": "XML mail template used when targetType is Reference, e.g. one containing to inject the current user's email as a recipient. If omitted, defaults to the mail template stored in the .emailOrderUserRecipientsTemplate setting." }, "subscribersList": { "type": "string", "description": "XML mail template used when targetType is SubscribersList, e.g. one containing to inject the subscriber list's emails as recipients. If omitted, defaults to the mail template stored in the .emailOrderSubscribersListRecipientsTemplate setting." }, "index": { "type": "integer", "description": "Index of the action within the rule's action collection", "format": "int32" }, "actionType": { "description": "Type of action to be executed.", "$ref": "#/components/schemas/RuleActionDataType" }, "executionTime": { "description": "When the action should be executed.", "$ref": "#/components/schemas/RuleExecutionTime" } }, "description": "Model for SendEmail rule action" }, "SendEmailRuleActionNonResource": { "title": "Send email rule action non resource", "type": "object", "properties": { "targetType": { "enum": [ "SubscribersList", "Reference" ], "type": "string", "description": "Target type selected by the user" }, "reference": { "type": "string", "description": "Reference that contains mail template for user's recipients" }, "subscribersList": { "type": "string", "description": "Subscribers List that contains mail template for subscriber's recipients" }, "index": { "type": "integer", "description": "Index of a rule action in collection", "format": "int32" }, "actionType": { "description": "Data type of this rule action", "$ref": "#/components/schemas/RuleActionDataType" }, "executionTime": { "description": "Execution time of the rule action", "$ref": "#/components/schemas/RuleExecutionTime" } }, "description": "Representation of Send email rule action" }, "SetFieldValueRuleActionModel": { "title": "Set field value rule action model", "type": "object", "properties": { "reference": { "type": "string", "description": "A dynamic-value expression whose result becomes the field's new value, e.g. ." }, "fieldDefinitionId": { "type": [ "null", "string" ], "description": "Id of the field definition to set the value for", "format": "uuid" }, "index": { "type": "integer", "description": "Index of the action within the rule's action collection", "format": "int32" }, "actionType": { "description": "Type of action to be executed.", "$ref": "#/components/schemas/RuleActionDataType" }, "executionTime": { "description": "When the action should be executed.", "$ref": "#/components/schemas/RuleExecutionTime" } }, "description": "Model for SetFieldValue rule action" }, "SetFieldValueRuleActionNonResource": { "title": "Set field value rule action non resource", "type": "object", "properties": { "reference": { "type": "string", "description": "The reference whose result will be used as field value." }, "fieldDefinitionId": { "type": [ "null", "string" ], "description": "The Id of the field whose value must be set.", "format": "uuid" }, "index": { "type": "integer", "description": "Index of a rule action in collection", "format": "int32" }, "actionType": { "description": "Data type of this rule action", "$ref": "#/components/schemas/RuleActionDataType" }, "executionTime": { "description": "Execution time of the rule action", "$ref": "#/components/schemas/RuleExecutionTime" } }, "description": "Value of the specified field to the result of the reference." }, "SettingCategoryCreateCommand": { "title": "Setting category create command", "type": "object", "properties": { "name": { "type": "string", "description": "Name of this setting category." }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelModel" }, "description": "Multi-language labels for the name of this setting category." }, "tag": { "type": "string", "description": "Free-form tag for this setting category." } }, "description": "Creates a new setting category." }, "SettingCategoryEditCommand": { "title": "Setting category edit command", "type": "object", "properties": { "name": { "type": "string", "description": "Name of this setting category." }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelModel" }, "description": "Multi-language labels for the name of this setting category." }, "tag": { "type": "string", "description": "Free-form tag for this setting category." } }, "description": "Updates an existing setting category." }, "SettingCategoryPagedCollectionResource": { "title": "Setting category paged collection resource", "type": "object", "properties": { "pageNumber": { "type": [ "null", "integer" ], "description": "The current page of this paged collection.", "format": "int32" }, "pageSize": { "type": [ "null", "integer" ], "description": "The current page size of this paged collection.", "format": "int32" }, "skip": { "type": [ "null", "integer" ], "description": "The current skip size of this paged collection.", "format": "int32" }, "take": { "type": [ "null", "integer" ], "description": "The current take size of this paged collection.", "format": "int32" }, "totalCount": { "type": "integer", "description": "The total count of items in this paged collection, not just on the current page.", "format": "int64" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/SettingCategoryResource" }, "description": "One page of this paged collection, which is a subcollection of the complete collection." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" }, "first": { "description": "A link to the first page of this paged collection.", "$ref": "#/components/schemas/Link" }, "prev": { "description": "A link to the previous page of this paged collection.", "$ref": "#/components/schemas/Link" }, "next": { "description": "A link to the next page of this paged collection.", "$ref": "#/components/schemas/Link" }, "last": { "description": "A link to the last page of this paged collection.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of a paged collection of setting categories." }, "SettingCategoryResource": { "title": "Setting category resource", "type": "object", "properties": { "id": { "type": "string", "description": "Id of this setting category.", "format": "uuid" }, "name": { "type": "string", "description": "Name of the setting category." }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelNonResource" }, "description": "Labels of this setting category." }, "tag": { "type": "string", "description": "Value for the Tag of this object. The value of this property has to be valid Xml. Opt-in: returned only when requested. Include via a \"select-settingcategory: Tag\" header." }, "modifiedOn": { "type": "string", "description": "Last modification datetime in UTC time.", "format": "date-time" }, "createdOn": { "type": "string", "description": "Creation datetime in UTC time.", "format": "date-time" }, "_links": { "type": "object", "properties": { "modifiedBy": { "description": "Relation to the user who modified this setting category.", "$ref": "#/components/schemas/Link" }, "createdBy": { "description": "Relation to the user who created this setting category.", "$ref": "#/components/schemas/Link" }, "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "modifiedBy": { "description": "Relation to the user who modified this setting category. Embed via a \"select-settingcategory: modifiedBy\" header.", "$ref": "#/components/schemas/UserResource" }, "createdBy": { "description": "Relation to the user who created this setting category. Embed via a \"select-settingcategory: createdBy\" header.", "$ref": "#/components/schemas/UserResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "A named grouping used to organize related system settings for display, e.g. in Config Studio." }, "SettingCollectionResource": { "title": "Setting collection resource", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/SettingResource" }, "description": "A collection of resource items." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of a collection of settings" }, "SettingDefinitionEditCommand": { "title": "Setting definition edit command", "type": "object", "properties": { "defaultValue": { "type": "string", "description": "Default value for this setting definition." }, "regularExpression": { "type": "string", "description": "Regular expression used to validate the value of this setting definition." }, "range": { "type": "string", "description": "Range of allowed values for this setting definition." }, "schema": { "type": "string", "description": "Schema used to validate the value of this setting definition." }, "name": { "type": "string", "description": "Name of this setting definition." }, "categoryId": { "type": "string", "description": "Id of the setting category this setting definition belongs to.", "format": "uuid" }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelModel" }, "description": "Multi-language labels for the name of this setting definition." }, "allowSystemSetting": { "type": "boolean", "description": "When set, allows this setting to be configured at the system level." }, "allowUserSetting": { "type": "boolean", "description": "When set, allows this setting to be configured at the user level." }, "roleRequiredForChange": { "type": "string", "description": "Name of the role required to change settings of this definition." }, "userGroupSettingMode": { "enum": [ "None", "MaximumValue", "MinimumValue", "Manual", "FirstValue" ], "type": "string", "description": "Algorithm used to calculate the effective value for user group settings of this definition." }, "helpUrl": { "type": "string", "description": "URL to help documentation for this setting definition." }, "tag": { "type": "string", "description": "Free-form tag for this setting definition." } }, "description": "Updates an existing setting definition." }, "SettingDefinitionPagedCollectionResource": { "title": "Setting definition paged collection resource", "type": "object", "properties": { "pageNumber": { "type": [ "null", "integer" ], "description": "The current page of this paged collection.", "format": "int32" }, "pageSize": { "type": [ "null", "integer" ], "description": "The current page size of this paged collection.", "format": "int32" }, "skip": { "type": [ "null", "integer" ], "description": "The current skip size of this paged collection.", "format": "int32" }, "take": { "type": [ "null", "integer" ], "description": "The current take size of this paged collection.", "format": "int32" }, "totalCount": { "type": "integer", "description": "The total count of items in this paged collection, not just on the current page.", "format": "int64" }, "items": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/BooleanSettingDefinitionResource" }, { "$ref": "#/components/schemas/DateTimeSettingDefinitionResource" }, { "$ref": "#/components/schemas/EncryptedTextSettingDefinitionResource" }, { "$ref": "#/components/schemas/NumericSettingDefinitionResource" }, { "$ref": "#/components/schemas/ReferenceSettingDefinitionResource" }, { "$ref": "#/components/schemas/RoleSettingDefinitionResource" }, { "$ref": "#/components/schemas/TextSettingDefinitionResource" }, { "$ref": "#/components/schemas/XmlSettingDefinitionResource" }, { "$ref": "#/components/schemas/DefSchemaSettingDefinitionResource" } ] }, "description": "One page of this paged collection, which is a subcollection of the complete collection." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" }, "first": { "description": "A link to the first page of this paged collection.", "$ref": "#/components/schemas/Link" }, "prev": { "description": "A link to the previous page of this paged collection.", "$ref": "#/components/schemas/Link" }, "next": { "description": "A link to the next page of this paged collection.", "$ref": "#/components/schemas/Link" }, "last": { "description": "A link to the last page of this paged collection.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of a paged collection of setting definitions." }, "SettingDefinitionResource": { "title": "Setting definition resource", "type": "object", "properties": { "id": { "type": "string", "description": "Id of the setting definition", "format": "uuid" }, "helpUrl": { "type": "string", "description": "Help url for the setting definition" }, "userGroupSettingMode": { "enum": [ "None", "MaximumValue", "MinimumValue", "Manual", "FirstValue" ], "type": "string", "description": "UserGroupSettingMode for the setting definition" }, "categoryId": { "type": "string", "description": "Category Id for the setting definition", "format": "uuid" }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelNonResource" }, "description": "Collection of labels for the setting definition" }, "allowSystemSetting": { "type": "boolean", "description": "Indicates whether this setting can be configured at the system level." }, "allowUserSetting": { "type": "boolean", "description": "Indicates whether this setting can be configured per user." }, "roleRequiredForChange": { "type": "string", "description": "Role that needs to be changed" }, "name": { "type": "string", "description": "Name of the setting definition" }, "dataType": { "enum": [ "None", "Boolean", "Text", "Numeric", "DateTime", "Xml", "Role", "Reference", "EncryptedText", "DefSchema" ], "type": "string", "description": "Data type of this setting" }, "tag": { "type": "string", "description": "Tag for this setting containing extra information. Opt-in: returned only when requested. Include via a \"select-settingdefinition: Tag\" header." }, "modifiedOn": { "type": "string", "description": "Last modification datetime in UTC time.", "format": "date-time" }, "createdOn": { "type": "string", "description": "Creation datetime in UTC time.", "format": "date-time" }, "_links": { "type": "object", "properties": { "modifiedBy": { "description": "Relation to the user who last modified this settingdefinition.", "$ref": "#/components/schemas/Link" }, "createdBy": { "description": "Relation to the user who created this settingdefinition.", "$ref": "#/components/schemas/Link" }, "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "modifiedBy": { "description": "Relation to the user who last modified this settingdefinition. Embed via a \"select-settingdefinition: modifiedBy\" header.", "$ref": "#/components/schemas/UserResource" }, "createdBy": { "description": "Relation to the user who created this settingdefinition. Embed via a \"select-settingdefinition: createdBy\" header.", "$ref": "#/components/schemas/UserResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "Defines the schema (name, data type, category) of a system setting, which can then be read or written via the Settings endpoints, subject to the settings whitelist." }, "SettingDefinitionType": { "title": "Setting definition type", "enum": [ "Boolean", "DateTime", "Numeric", "Reference", "Role", "Text", "Xml", "EncryptedText", "DefSchema" ], "type": "string", "x-enum-descriptions": [ "Setting definition holding a boolean value.", "Setting definition holding a date/time value.", "Setting definition holding a numeric value.", "Setting definition holding a reference value.", "Setting definition holding a role value.", "Setting definition holding a text value.", "Setting definition holding an XML value.", "Setting definition holding an encrypted text value.", "Setting definition holding a value validated against a def schema." ] }, "SettingEditCommand": { "title": "Setting edit command", "type": "object", "properties": { "name": { "type": "string", "description": "Name of the setting definition to update." }, "value": { "type": "string", "description": "New value for this setting." }, "scope": { "description": "Scope at which this setting is stored.", "$ref": "#/components/schemas/SettingScopeModel" }, "scopeId": { "type": [ "null", "string" ], "description": "Id of the entity that this setting is scoped to, when Scope requires one.", "format": "uuid" } }, "description": "Updates the value of an existing setting." }, "SettingResource": { "title": "Setting resource", "type": "object", "properties": { "name": { "type": "string", "description": "Name of the setting" }, "value": { "type": "string", "description": "Value of the setting" }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Represents a single setting in DAM. Because settings can contain sensitive information, an additional security measure is present in the REST API preventing access to settings unless explicitly allowed by the DAM administrator. In order to access (read/write) any of the settings in DAM, the administrator first needs to configure an allowlist of all the settings allowed to be accessed through the REST API. This allowlist is a system setting in DAM, named '.rest_SettingsWhitelist', in the form of a comma-separated list of allowed setting names, and can be updated through the System Studio. However, the allowlist does not affect users from the DAM Administrator user group: they have access to all their DAM settings, irrespective of the allowlist. After the allowlist has been properly configured, consumers can access the settings specified in the allowlist via the REST API." }, "SettingScopeModel": { "title": "Setting scope model", "enum": [ "Site", "System", "User", "UserGroup" ], "type": "string", "x-enum-descriptions": [ "Setting is stored at the site level.", "Setting is stored at the system level.", "Setting is stored for a specific user.", "Setting is stored for a specific user group." ] }, "ShareDownloadLinkOrderCreateCommand": { "title": "Share download link order create command", "type": "object", "properties": { "sendEmail": { "type": "boolean", "description": "When set, emails the share link to the specified recipients." }, "useVerification": { "type": "boolean", "description": "When set, requires recipients to verify their identity before downloading." }, "expirationDateTime": { "type": "string", "description": "Date and time after which the share link is no longer valid.", "format": "date-time" }, "emailRecipients": { "type": "array", "items": { "type": "string" }, "description": "Email addresses that receive the notification." }, "emailMessage": { "type": "string", "description": "Body text of the notification email." }, "brandPortalUri": { "type": "string", "description": "URI of the Brand Portal used to serve the share link." }, "downloadAgreementContentId": { "type": "integer", "description": "Id of the download agreement content that recipients must accept before downloading.", "format": "int32" }, "displayName": { "type": "string", "description": "A human-readable display name for what is being shared (e.g. a collection's name) Optional - omitted links fall back to the stored file name." }, "originType": { "type": "string", "description": "The kind of DAM entity being shared. One of ContentItem, Collection, Basket, Selection (case-insensitive). Optional - omitted links fall back to the file-count-derived share type." }, "deliveryLocation": { "type": "string", "description": "Location where the order output is delivered." }, "includeTargets": { "type": "boolean", "description": "When set, includes the resolved order targets in the response." }, "disableProcessing": { "type": "string", "description": "When set, disables further processing of the order." }, "creatorEmail": { "type": "string", "description": "Email address of the user the job is created on behalf of." }, "disableNotification": { "type": "boolean", "description": "When set to true, suppresses notifications for this job." }, "earliestStartDate": { "type": [ "null", "string" ], "description": "Earliest date and time at which the job is allowed to start executing.", "format": "date-time" }, "priority": { "enum": [ "High", "Medium" ], "type": "string", "description": "Priority used to schedule this job relative to other maintenance jobs." }, "type": { "enum": [ "Classification", "Record", "ExportAuditTrail", "BulkRecord", "AcceptDownloadOrderAgreement", "BulkCollection", "ExportContentItemsList" ], "type": "string", "description": "Type of maintenance job to create." }, "targets": { "type": "array", "items": { "$ref": "#/components/schemas/OrderTargetModel" }, "description": "Targets the job's actions are applied to." }, "actions": { "type": "array", "items": { "$ref": "#/components/schemas/ActionModel" }, "description": "Actions to execute for each target of this job." }, "title": { "type": "string", "description": "Title of the job. For a download or contact-sheet order this is shown on the Downloads page in Content Workspace; if omitted, it defaults to the file name, or \"X items\" when multiple files were ordered. Either plain text, or a JSON string of the form {\"studioName\":\"...\",\"moduleName\":\"...\",\"translationKey\":\"...\"} to look up a translated value for non-English users (see the Localization > Translations section of the DAM Administrator Guide for how translations are registered)." }, "description": { "type": "string", "description": "Description of the job. For a download or contact-sheet order this is shown on the Downloads page in Content Workspace; if omitted, it defaults to \"Download\". Accepts the same plain-text-or-translation-key JSON format as Title." }, "errorMode": { "type": "string", "description": "Determines how the job behaves when one of its targets fails to execute." } }, "description": "Payload for creating an order that generates a shareable link for downloading records." }, "ShareDownloadLinkOrderResource": { "title": "Share download link order resource", "type": "object", "properties": { "shareUri": { "type": "string", "description": "The shareable link" }, "emailRecipients": { "type": "array", "items": { "type": "string" }, "description": "The recipients to send the mail to" }, "emailMessage": { "type": "string", "description": "The body of the notification email sent to recipients. Mirrors the \"emailMessage\" field accepted on the shareDownloadLink order create request." }, "sendEmail": { "type": "boolean", "description": "True if the mail should be sent to the recipients" }, "sharedDownloadLinkId": { "type": [ "null", "string" ], "description": "The id of the shared download link", "format": "uuid" }, "orderType": { "type": "string", "description": "Type of the order" }, "deliveredFiles": { "type": "array", "items": { "type": "string" }, "description": "The files delivered to the client by this order." }, "totalFileSize": { "type": "integer", "description": "Total file size of the delivered files", "format": "int64" }, "creatorEmail": { "type": "string", "description": "E-mail address for this job" }, "disableNotification": { "type": "boolean", "description": "Value indicating whether or not notification is enabled on this job" }, "earliestStartDate": { "type": [ "null", "string" ], "description": "The earliest date in utc time on which this job can be executed.", "format": "date-time" }, "executionTime": { "type": "string", "description": "Time it took for this maintenance job to execute." }, "id": { "type": "string", "description": "Id of this maintenance job.", "format": "uuid" }, "type": { "type": "string", "description": "Name of this maintenance job." }, "priority": { "enum": [ "High", "Medium", "AuditArchiving", "BuildSearchIndex" ], "type": "string", "description": "Priority of this maintenance job." }, "startedOn": { "type": [ "null", "string" ], "description": "Time on which the execution of this maintenance job started in utc time.", "format": "date-time" }, "status": { "enum": [ "Pending", "Success", "Failed", "PartiallyFailed", "Executing", "Cancelled", "Scheduled", "Queued", "AsyncPending", "AsyncExecuting" ], "type": "string", "description": "Status of this maintenance job." }, "message": { "type": [ "null", "string" ], "description": "Error message that describes why this maintenance job failed. Returns null if this maintenance job hasn't been executed yet." }, "failedTargetsCount": { "type": "integer", "description": "Count of the failed targets.", "format": "int32" }, "createdOn": { "type": "string", "description": "Creation datetime in UTC time.", "format": "date-time" }, "_links": { "type": "object", "properties": { "targets": { "description": "Relation to a collection of order targets.", "$ref": "#/components/schemas/Link" }, "createdBy": { "description": "Relation to the user who created this maintenance job.", "$ref": "#/components/schemas/Link" }, "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "targets": { "description": "Relation to a collection of order targets. Embed via a \"select-order: targets\" header.", "$ref": "#/components/schemas/OrderTargetCollectionResource" }, "createdBy": { "description": "Relation to the user who created this maintenance job. Embed via a \"select-sharedownloadlinkorder: createdBy\" header.", "$ref": "#/components/schemas/UserResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "Representation of a shareable download link order." }, "SharedDownloadLinkDownloadCollectionResource": { "title": "Shared download link download collection resource", "type": "object", "properties": { "downloads": { "type": "array", "items": { "$ref": "#/components/schemas/SharedDownloadLinkDownloadResource" }, "description": "The download-activity events on this page, newest first." }, "totalCount": { "type": "integer", "description": "The total number of download-activity events for the link (across all pages).", "format": "int32" } }, "description": "A page of download-activity events for a shared download link, newest first." }, "SharedDownloadLinkDownloadResource": { "title": "Shared download link download resource", "type": "object", "properties": { "fileName": { "type": "string", "description": "The name of the file (as presented to recipients) that was downloaded." }, "recipientEmail": { "type": "string", "description": "The e-mail address of the recipient that downloaded the file." }, "downloadedOn": { "type": "string", "description": "The datetime in UTC time on which the download occurred.", "format": "date-time" } }, "description": "Representation of a single download-activity event for a shared download link - which file, which recipient, and when." }, "SharedDownloadLinkFileCollectionResource": { "title": "Shared download link file collection resource", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/SharedDownloadLinkFileResource" }, "description": "A collection of resource items." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of a paged collection of shared download link files" }, "SharedDownloadLinkFileDownloadUriResource": { "title": "Shared download link file download uri resource", "type": "object", "properties": { "fileId": { "type": "integer", "description": "File ID.", "format": "int32" }, "sharedDownloadLinkId": { "type": "string", "description": "Unique ID of the shared download link.", "format": "uuid" }, "downloadUri": { "type": "string", "description": "Actual URL of the shared download link." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of the link to a file included in a shared download link." }, "SharedDownloadLinkFileResource": { "title": "Shared download link file resource", "type": "object", "properties": { "id": { "type": "integer", "description": "File ID.", "format": "int32" }, "fileName": { "type": "string", "description": "File name." }, "fileSize": { "type": "integer", "description": "File size.", "format": "int64" }, "sourceFileCount": { "type": "integer", "description": "Amount of files included.", "format": "int64" }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of a file included in a shared download link." }, "SharedDownloadLinkListItemFileResource": { "title": "Shared download link list item file resource", "type": "object", "properties": { "id": { "type": "integer", "description": "The Id of the file within the shared download link.", "format": "int32" }, "fileName": { "type": "string", "description": "The name of the file as presented to recipients." }, "sourceFileCount": { "type": "integer", "description": "The number of source files that were bundled into this file.", "format": "int32" } }, "description": "Representation of a file of a shared download link as part of the shared download links collection." }, "SharedDownloadLinkListItemResource": { "title": "Shared download link list item resource", "type": "object", "properties": { "id": { "type": "string", "description": "The Id of this shared download link.", "format": "uuid" }, "useVerification": { "type": "boolean", "description": "Whether verification is required." }, "sendEmail": { "type": "boolean", "description": "Whether an e-mail was sent." }, "expiresOn": { "type": [ "null", "string" ], "description": "Expiration datetime in UTC time.", "format": "date-time" }, "revokedOn": { "type": [ "null", "string" ], "description": "Datetime in UTC time on which this shared download link was revoked, or null when the link has not been revoked. A revoked link no longer grants downloads.", "format": "date-time" }, "resourcePurgedOn": { "type": [ "null", "string" ], "description": "Datetime in UTC time on which this shared download link's underlying resource was purged, or null when the resource is still present. An expired link can only be reactivated while its resource has not yet been purged.", "format": "date-time" }, "displayName": { "type": [ "null", "string" ], "description": "Human-readable display name of what was shared (e.g. a collection's name), or null when it was not captured at creation time - consumers should fall back to the stored file name" }, "originType": { "type": [ "null", "string" ], "description": "Kind of DAM entity this link was shared from (ContentItem, Collection, Basket, or Selection), or null when it was not captured at creation time - consumers should fall back to the file-count-derived share type" }, "downloadCount": { "type": "integer", "description": "Total number of times this shared download link's files have been downloaded. 0 when it has never been downloaded.", "format": "int32" }, "createdByName": { "type": "string", "description": "Display name of the user that created this shared download link." }, "recipients": { "type": "array", "items": { "type": "string" }, "description": "E-mail addresses of the recipients of this shared download link." }, "files": { "type": "array", "items": { "$ref": "#/components/schemas/SharedDownloadLinkListItemFileResource" }, "description": "Files included in this shared download link." }, "createdOn": { "type": "string", "description": "Creation datetime in UTC time.", "format": "date-time" }, "_links": { "type": "object", "properties": { "createdBy": { "description": "Relation to the user who created this subscription.", "$ref": "#/components/schemas/Link" }, "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "createdBy": { "description": "Relation to the user who created this subscription. Embed via a \"select-shareddownloadlinklistitem: createdBy\" header.", "$ref": "#/components/schemas/UserResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "Representation of a shared download link as an item in the shared download links collection." }, "SharedDownloadLinkPagedCollectionResource": { "title": "Shared download link paged collection resource", "type": "object", "properties": { "pageNumber": { "type": [ "null", "integer" ], "description": "The current page of this paged collection.", "format": "int32" }, "pageSize": { "type": [ "null", "integer" ], "description": "The current page size of this paged collection.", "format": "int32" }, "skip": { "type": [ "null", "integer" ], "description": "The current skip size of this paged collection.", "format": "int32" }, "take": { "type": [ "null", "integer" ], "description": "The current take size of this paged collection.", "format": "int32" }, "totalCount": { "type": "integer", "description": "The total count of items in this paged collection, not just on the current page.", "format": "int64" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/SharedDownloadLinkListItemResource" }, "description": "One page of this paged collection, which is a subcollection of the complete collection." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" }, "first": { "description": "A link to the first page of this paged collection.", "$ref": "#/components/schemas/Link" }, "prev": { "description": "A link to the previous page of this paged collection.", "$ref": "#/components/schemas/Link" }, "next": { "description": "A link to the next page of this paged collection.", "$ref": "#/components/schemas/Link" }, "last": { "description": "A link to the last page of this paged collection.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "A paged collection of SharedDownloadLinkListItemResource items. The collection contains the shared download links created by the current user, or by all users of the tenant when requested by an administrator." }, "SharedDownloadLinkRecipientSearchResource": { "title": "Shared download link recipient search resource", "type": "object", "properties": { "emails": { "type": "array", "items": { "type": "string" }, "description": "The distinct recipient email addresses on this page, ordered alphabetically." }, "totalCount": { "type": "integer", "description": "The total number of distinct recipient emails matching the search (across all pages).", "format": "int32" } }, "description": "A page of distinct recipient email addresses matching a search - powers the Recipient filter's autocomplete suggestion list." }, "SharedDownloadLinkResource": { "title": "Shared download link resource", "type": "object", "properties": { "id": { "type": "string", "description": "The Id of this shared download link.", "format": "uuid" }, "useVerification": { "type": "boolean", "description": "Whether verification is required." }, "sendEmail": { "type": "boolean", "description": "Whether an e-mail was sent." }, "expiresOn": { "type": [ "null", "string" ], "description": "Expiration datetime in UTC time.", "format": "date-time" }, "revokedOn": { "type": [ "null", "string" ], "description": "Datetime in UTC time on which this shared download link was revoked, or null when the link has not been revoked. A revoked link no longer grants downloads.", "format": "date-time" }, "resourcePurgedOn": { "type": [ "null", "string" ], "description": "Datetime in UTC time on which this shared download link's underlying resource was purged, or null when the resource is still present. An expired link can only be reactivated (by changing its expiration date) while its resource has not yet been purged.", "format": "date-time" }, "displayName": { "type": [ "null", "string" ], "description": "Human-readable display name of what was shared (e.g. a collection's name), or null when it was not captured at creation time - consumers should fall back to the stored file name." }, "originType": { "type": [ "null", "string" ], "description": "Kind of DAM entity this link was shared from (ContentItem, Collection, Basket, or Selection), or null when it was not captured at creation time - consumers should fall back to the file-count-derived share type." }, "downloadCount": { "type": "integer", "description": "Total number of times this shared download link's files have been downloaded. 0 when it has never been downloaded.", "format": "int32" }, "createdOn": { "type": "string", "description": "Creation datetime in UTC time.", "format": "date-time" }, "_links": { "type": "object", "properties": { "files": { "description": "Relation to the files that can be downloaded via the shared download link.", "$ref": "#/components/schemas/Link" }, "createdBy": { "description": "Relation to the user who created this subscription.", "$ref": "#/components/schemas/Link" }, "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "files": { "description": "Relation to the files that can be downloaded via the shared download link. Embed via a \"select-shareddownloadlink: files\" header.", "$ref": "#/components/schemas/SharedDownloadLinkFileCollectionResource" }, "createdBy": { "description": "Relation to the user who created this subscription. Embed via a \"select-shareddownloadlink: createdBy\" header.", "$ref": "#/components/schemas/UserResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "A link to a set of files, sent by email to a specific recipient, with an optional expiration date and email-verification-code requirement - a more controlled alternative to a plain public link for sharing downloads with a named person." }, "SingleLineTextFieldDefinitionCreateCommand": { "title": "Single line text field definition create command", "type": "object", "properties": { "isUniqueIdentifier": { "type": "boolean", "description": "When set to true, the field value must be unique across records." }, "maximumLength": { "type": "integer", "description": "Maximum number of characters allowed for the field value.", "format": "int32" }, "minimumLength": { "type": "integer", "description": "Minimum number of characters required for the field value.", "format": "int32" }, "regularExpression": { "type": "string", "description": "Regular expression the field value must match." }, "aIEnabled": { "type": "boolean", "description": "When set to true, AI-based content generation is enabled for this field." }, "metadataPredictionEnabled": { "type": "boolean", "description": "When set to true, this field's value can be predicted using AI-based metadata prediction." }, "hints": { "type": "string", "description": "Hints used to guide AI-based metadata prediction for this field." }, "dataType": { "description": "Data type of the field definition. Determines which other properties apply.", "$ref": "#/components/schemas/FieldDefinitionType" }, "enabledLanguages": { "description": "Languages in which this field is enabled. Use AddOrUpdate to add or update members, or Remove to remove them.", "$ref": "#/components/schemas/EditableIdCollectionModel" }, "indexed": { "type": "boolean", "description": "When set to true, the field is indexed for search." }, "inlineStyle": { "type": "string", "description": "Inline CSS style applied to the field in the DAM UI." }, "isReadOnly": { "type": "boolean", "description": "When set to true, the field cannot be edited." }, "isRequired": { "type": "boolean", "description": "When set to true, the field is required." }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelModel" }, "description": "Multi-language labels for the name of this field." }, "languageMode": { "type": "string", "description": "Language mode of the field." }, "memberships": { "description": "Field groups this field is a member of. Use AddOrUpdate to add or update members, or Remove to remove them.", "$ref": "#/components/schemas/EditableIdCollectionModel" }, "name": { "type": "string", "description": "Name of the field." }, "scope": { "type": "string", "description": "Scope of the field." }, "sortIndex": { "type": "integer", "description": "Sort index used to order the field relative to other fields.", "format": "int32" }, "tag": { "type": "string", "description": "Tag associated with the field." }, "defaultValue": { "type": "string", "description": "Default value assigned to the field." }, "resetToDefaultTriggers": { "type": "array", "items": { "type": "string" }, "description": "Names of the triggers that reset the field to its default value." }, "resetToDefaultFields": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Ids of the fields that reset this field to its default value when they change." }, "validation": { "type": "string", "description": "Validation expression applied to the field value." }, "validationErrorMessage": { "type": "string", "description": "Error message shown when validation fails." }, "validationTrigger": { "type": "string", "description": "Trigger that determines when validation is applied." }, "storageMode": { "type": "string", "description": "Storage mode of the field." }, "helpTexts": { "type": "array", "items": { "$ref": "#/components/schemas/HelpTextModel" }, "description": "Multi-language help texts for this field." } }, "description": "Command to create a single-line text field definition." }, "SingleLineTextFieldDefinitionResource": { "title": "Single line text field definition resource", "type": "object", "properties": { "minimumLength": { "type": "integer", "description": "The minimum length for the field.", "format": "int32" }, "maximumLength": { "type": "integer", "description": "The maximum length for the field.", "format": "int32" }, "regularExpression": { "type": "string", "description": "A regular expression for validating the field." }, "aIEnabled": { "type": "boolean", "description": "Indicates whether to allow AI enhancement." }, "metadataPredictionEnabled": { "type": "boolean", "description": "Indicates whether the field can be predicted by the AI." }, "hints": { "type": "string", "description": "AI Prediction hint for this field." }, "label": { "type": "string", "description": "Label of this field." }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelNonResource" }, "description": "A collection of Label items." }, "dataType": { "$ref": "#/components/schemas/FieldDataType" }, "scope": { "enum": [ "RecordContentGlobal", "RecordContentClassDependent", "RecordContentFloating", "ClassificationProfileClassDependent", "UserGlobal", "FileFileTypeDependent", "FileFloating", "IndexerTaskGlobal", "FileGlobal", "ClassificationProfileFloating", "RecordContentContentTypeDependent" ], "type": "string", "description": "Scope." }, "scopeCategory": { "enum": [ "Record", "File", "Classification", "User", "IndexerTask", "MetadataTemplate" ], "type": "string", "description": "Scope category." }, "indexed": { "type": "boolean", "description": "Indicator if searching on this field is enabled." }, "languageMode": { "enum": [ "Single", "Multiple" ], "type": "string", "description": "Language mode of the field." }, "memberships": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Memberships of a field." }, "searchIndexRebuildRequired": { "type": "boolean", "description": "Indicator if a search index rebuild is required." }, "enabledLanguages": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Enabled languages." }, "id": { "type": "string", "description": "Identifier for this field.", "format": "uuid" }, "name": { "type": "string", "description": "Name for this field." }, "isRequired": { "type": "boolean", "description": "Indicates whether this field is required." }, "isReadOnly": { "type": "boolean", "description": "Indicates whether this field is read only." }, "isUniqueIdentifier": { "type": "boolean", "description": "Indicates whether this field is a unique identifier." }, "inlineStyle": { "type": "string", "description": "Inline CSS style applied to this field." }, "sortIndex": { "type": "integer", "description": "Sorting index of this field.", "format": "int32" }, "tag": { "type": "string", "description": "Tag for this field containing extra information. Opt-in: returned only when requested. Include via a \"select-fielddefinition: Tag\" header." }, "createdOn": { "type": "string", "description": "Created on the specified date in UTC time", "format": "date-time" }, "modifiedOn": { "type": "string", "description": "Modified on the specified date in UTC time", "format": "date-time" }, "defaultValue": { "type": "string", "description": "Default value of this field." }, "resetToDefaultTriggers": { "type": "array", "items": { "enum": [ "None", "OnNewField", "OnLoad", "OnSave", "OnAnyFileChange", "OnReclassifyRecord", "OnAnyChange", "OnFieldChange", "OnMasterFileChange", "OnCurrentFileChange", "OnFieldDefinitionChanged", "OnDuplicateRecord", "OnRecordStatusChange" ], "type": "string" }, "description": "'reset to default triggers' value of this field." }, "validation": { "type": "string", "description": "Validation of this field." }, "validationErrorMessage": { "type": "string", "description": "Error message of this field." }, "validationTrigger": { "enum": [ "None", "WhenNeeded", "Always" ], "type": "string", "description": "Trigger that determines when validation is evaluated for this field." }, "storageMode": { "enum": [ "None", "NonEmptyValues", "AllValues", "LogChanges" ], "type": "string", "description": "Storage mode of this field." }, "resetToDefaultFields": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Fields that trigger this field to be reset back to its default value. This is only used if \"ResetToDefaultTriggers\" is set to \"OnFieldChange\"." }, "helpText": { "type": "string", "description": "Help text of this field." }, "helpTexts": { "type": "array", "items": { "$ref": "#/components/schemas/HelpTextNonResource" }, "description": "A collection of HelpText items." }, "_links": { "type": "object", "properties": { "createdBy": { "description": "Relation to the user who created this field definition.", "$ref": "#/components/schemas/Link" }, "modifiedBy": { "description": "Relation to the user who last modified this field definition.", "$ref": "#/components/schemas/Link" }, "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "createdBy": { "description": "Relation to the user who created this field definition. Embed via a \"select-fielddefinition: createdBy\" header.", "$ref": "#/components/schemas/UserResource" }, "modifiedBy": { "description": "Relation to the user who last modified this field definition. Embed via a \"select-fielddefinition: modifiedBy\" header.", "$ref": "#/components/schemas/UserResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "Representation of the definition of a single-line text field" }, "SingleLineTextFieldResource": { "title": "Single line text field resource", "type": "object", "properties": { "dataType": { "$ref": "#/components/schemas/FieldDataType" }, "fieldName": { "type": "string", "description": "Name of this field." }, "label": { "type": "string", "description": "Label of this field." }, "id": { "type": "string", "description": "Id of this field.", "format": "uuid" }, "localizedValues": { "type": "array", "items": { "$ref": "#/components/schemas/SingleLineTextFieldValue" }, "description": "Language specific data of this field." }, "inheritanceState": { "enum": [ "None", "Inherited" ], "type": [ "null", "string" ], "description": "Inheritance State of this field. Opt-in: returned only when requested. Include via a \"select-field: InheritanceState\" header." }, "inheritable": { "type": [ "null", "boolean" ], "description": "Whether the field value can be used as a parent in inheritance hierarchy. Opt-in: returned only when requested. Include via a \"select-field: Inheritable\" header." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" }, "definition": { "description": "Relation to the field definition.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "definition": { "description": "Relation to the field definition. Embed via a \"select-singlelinetextfield: definition\" header.", "$ref": "#/components/schemas/FieldDefinitionResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "A single-line text field value on a record, file, classification, or user, including its language-specific values." }, "SingleLineTextFieldValue": { "title": "Single line text field value", "type": "object", "properties": { "value": { "type": "string", "description": "Text which can't contain new-line characters." }, "aIInfluenced": { "type": "boolean", "description": "Flag to indicate whether the value has come from AI." }, "languageId": { "type": "string", "description": "The language id.", "format": "uuid" }, "readOnly": { "type": [ "null", "boolean" ], "description": "Tells if the field is read-only." }, "modifiedOn": { "type": "string", "description": "Contains the date/time when the field is last modified.", "format": "date-time" } }, "description": "Language-specific SingleLineTextField value." }, "SmartActionScanResultPagedCollectionResource": { "title": "Smart action scan result paged collection resource", "type": "object", "properties": { "pageNumber": { "type": [ "null", "integer" ], "description": "The current page of this paged collection.", "format": "int32" }, "pageSize": { "type": [ "null", "integer" ], "description": "The current page size of this paged collection.", "format": "int32" }, "skip": { "type": [ "null", "integer" ], "description": "The current skip size of this paged collection.", "format": "int32" }, "take": { "type": [ "null", "integer" ], "description": "The current take size of this paged collection.", "format": "int32" }, "totalCount": { "type": "integer", "description": "The total count of items in this paged collection, not just on the current page.", "format": "int64" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/SmartActionScanResultResource" }, "description": "One page of this paged collection, which is a subcollection of the complete collection." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" }, "first": { "description": "A link to the first page of this paged collection.", "$ref": "#/components/schemas/Link" }, "prev": { "description": "A link to the previous page of this paged collection.", "$ref": "#/components/schemas/Link" }, "next": { "description": "A link to the next page of this paged collection.", "$ref": "#/components/schemas/Link" }, "last": { "description": "A link to the last page of this paged collection.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of a paged collection of smart action scan results" }, "SmartActionScanResultResource": { "title": "Smart action scan result resource", "type": "object", "properties": { "id": { "type": "string", "description": "The Id of this SmartActionScanResult.", "format": "uuid" }, "fileVersionId": { "type": "string", "description": "The File Version Id of this SmartActionScanResult.", "format": "uuid" }, "smartActionId": { "type": "integer", "description": "The Page Number of this SmartActionScanResult.", "format": "int32" }, "concerns": { "type": "array", "items": { "$ref": "#/components/schemas/ContentItemScanResult" }, "description": "The list of findings." }, "scanResultRead": { "type": "integer", "description": "Whether the scan results have been read", "format": "int32" }, "createdBy": { "type": "string", "description": "The creator id of this SmartActionScanResult", "format": "uuid" }, "modifiedBy": { "type": "string", "description": "The modifier id of this SmartActionScanResult", "format": "uuid" }, "createdOn": { "type": "string", "description": "The date when this SmartActionScanResult was created", "format": "date-time" }, "modifiedOn": { "type": "string", "description": "The date when this SmartActionScanResult was updated", "format": "date-time" }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of an SmartActionScanResult." }, "SpinsetResource": { "title": "Spinset resource", "type": "object", "properties": { "id": { "type": "string", "description": "Identifier for this additional file.", "format": "uuid" }, "type": { "description": "Type of this additional file. On the additional files collection endpoint, the results can be restricted to specific types with a \"select-additionalfile-type\" request header (comma-separated AdditionalFileType names).", "$ref": "#/components/schemas/AdditionalFileType" }, "isManual": { "type": "boolean", "description": "Returns true if this additional has been added manually. false is returned if the additional file was created automatically." }, "label": { "type": "string", "description": "Label of the additional file" }, "fileSize": { "type": "integer", "description": "File size of the additional file", "format": "int64" }, "fileName": { "type": "string", "description": "File name of the additional file" }, "extension": { "type": "string", "description": "File extension of the additional file" }, "tag": { "type": "string", "description": "Tag of the additional file Opt-in: returned only when requested. Include via a \"select-additionalfile: Tag\" header." }, "usages": { "type": "array", "items": { "type": "string" }, "description": "Usages of the additional file. On the additional files collection endpoint, the results can be restricted to specific usages with a \"select-additionalfile-usage\" request header (comma-separated values)." }, "uri": { "type": "string", "description": "Returns a path to image or if no image is assigned. This URL remains valid for four hours. Opt-in: returned only when requested. Include via a \"select-additionalfile: Uri\" header." }, "metadata": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Technical metadata specific to this additional file's type (e.g. video duration, image resolution). The available keys vary by file type and aren't individually documented. Opt-in: returned only when requested. Include via a \"select-additionalfile: Metadata\" header." }, "purposes": { "type": "array", "items": { "type": "string" }, "description": "Purposes of the additional file. On the additional files collection endpoint, the results can be restricted to specific purposes with a \"select-filter-purposes\" request header (comma-separated values)." }, "crc32": { "type": "integer", "description": "CRC32 checksum of this additional file.", "format": "int32" }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" }, "publicLink": { "description": "Relation to the addition file public link.", "$ref": "#/components/schemas/Link" }, "mainPreview": { "description": "Relation to an image of main preview with the size of a preview.", "$ref": "#/components/schemas/Link" }, "filePreviews": { "description": "Relation to a collection of file previews.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "publicLink": { "description": "Relation to the addition file public link. Embed via a \"select-additionalfile: publicLink\" header.", "$ref": "#/components/schemas/PublicLinkResource" }, "mainPreview": { "description": "Relation to an image of main preview with the size of a preview. Embed via a \"select-additionalfile: mainPreview\" header.", "$ref": "#/components/schemas/ImageResource" }, "filePreviews": { "description": "Relation to a collection of file previews. Embed via a \"select-additionalfile: filePreviews\" header.", "$ref": "#/components/schemas/AdditionalFilePreviewCollectionResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "Representation of a Spinset" }, "StillResource": { "title": "Still resource", "type": "object", "properties": { "offset": { "type": "number", "description": "Offset of the still.", "format": "double" }, "timeStamp": { "type": "number", "description": "Timestamp of the still.", "format": "double" }, "creationMode": { "description": "Creation mode of the still.", "$ref": "#/components/schemas/VideoStillCreationMode" }, "preview": { "type": "string", "description": "The preview of the still Opt-in: returned only when requested. Include via a \"select-additionalfile: Preview\" header." }, "id": { "type": "string", "description": "Identifier for this additional file.", "format": "uuid" }, "type": { "description": "Type of this additional file. On the additional files collection endpoint, the results can be restricted to specific types with a \"select-additionalfile-type\" request header (comma-separated AdditionalFileType names).", "$ref": "#/components/schemas/AdditionalFileType" }, "isManual": { "type": "boolean", "description": "Returns true if this additional has been added manually. false is returned if the additional file was created automatically." }, "label": { "type": "string", "description": "Label of the additional file" }, "fileSize": { "type": "integer", "description": "File size of the additional file", "format": "int64" }, "fileName": { "type": "string", "description": "File name of the additional file" }, "extension": { "type": "string", "description": "File extension of the additional file" }, "tag": { "type": "string", "description": "Tag of the additional file Opt-in: returned only when requested. Include via a \"select-additionalfile: Tag\" header." }, "usages": { "type": "array", "items": { "type": "string" }, "description": "Usages of the additional file. On the additional files collection endpoint, the results can be restricted to specific usages with a \"select-additionalfile-usage\" request header (comma-separated values)." }, "uri": { "type": "string", "description": "Returns a path to image or if no image is assigned. This URL remains valid for four hours. Opt-in: returned only when requested. Include via a \"select-additionalfile: Uri\" header." }, "metadata": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Technical metadata specific to this additional file's type (e.g. video duration, image resolution). The available keys vary by file type and aren't individually documented. Opt-in: returned only when requested. Include via a \"select-additionalfile: Metadata\" header." }, "purposes": { "type": "array", "items": { "type": "string" }, "description": "Purposes of the additional file. On the additional files collection endpoint, the results can be restricted to specific purposes with a \"select-filter-purposes\" request header (comma-separated values)." }, "crc32": { "type": "integer", "description": "CRC32 checksum of this additional file.", "format": "int32" }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" }, "publicLink": { "description": "Relation to the addition file public link.", "$ref": "#/components/schemas/Link" }, "mainPreview": { "description": "Relation to an image of main preview with the size of a preview.", "$ref": "#/components/schemas/Link" }, "filePreviews": { "description": "Relation to a collection of file previews.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "publicLink": { "description": "Relation to the addition file public link. Embed via a \"select-additionalfile: publicLink\" header.", "$ref": "#/components/schemas/PublicLinkResource" }, "mainPreview": { "description": "Relation to an image of main preview with the size of a preview. Embed via a \"select-additionalfile: mainPreview\" header.", "$ref": "#/components/schemas/ImageResource" }, "filePreviews": { "description": "Relation to a collection of file previews. Embed via a \"select-additionalfile: filePreviews\" header.", "$ref": "#/components/schemas/AdditionalFilePreviewCollectionResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "Representation of a Still" }, "SubscriptionCreateCommand": { "title": "Subscription create command", "type": "object", "properties": { "objectId": { "type": "string", "description": "Id of the record or collection the subscription applies to.", "format": "uuid" }, "userId": { "type": "string", "description": "Id of the user the subscription belongs to.", "format": "uuid" }, "subscriptionType": { "enum": [ "Follow", "Expiry" ], "type": "string", "description": "Type of subscription, using the same values as SubscriptionType." }, "subscriptionObjectType": { "enum": [ "Record", "Collection" ], "type": "string", "description": "Type of object being subscribed to, using the same values as SubscriptionObjectType." } }, "description": "Creates a subscription for a user to a record or collection." }, "SubscriptionPagedCollectionResource": { "title": "Subscription paged collection resource", "type": "object", "properties": { "pageNumber": { "type": [ "null", "integer" ], "description": "The current page of this paged collection.", "format": "int32" }, "pageSize": { "type": [ "null", "integer" ], "description": "The current page size of this paged collection.", "format": "int32" }, "skip": { "type": [ "null", "integer" ], "description": "The current skip size of this paged collection.", "format": "int32" }, "take": { "type": [ "null", "integer" ], "description": "The current take size of this paged collection.", "format": "int32" }, "totalCount": { "type": "integer", "description": "The total count of items in this paged collection, not just on the current page.", "format": "int64" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionResource" }, "description": "One page of this paged collection, which is a subcollection of the complete collection." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" }, "first": { "description": "A link to the first page of this paged collection.", "$ref": "#/components/schemas/Link" }, "prev": { "description": "A link to the previous page of this paged collection.", "$ref": "#/components/schemas/Link" }, "next": { "description": "A link to the next page of this paged collection.", "$ref": "#/components/schemas/Link" }, "last": { "description": "A link to the last page of this paged collection.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of a paged collection of subscriptions" }, "SubscriptionResource": { "title": "Subscription resource", "type": "object", "properties": { "id": { "type": "string", "description": "The Id of this subscription.", "format": "uuid" }, "objectId": { "type": "string", "description": "The Record Id of this subscription.", "format": "uuid" }, "userId": { "type": "string", "description": "The User Id of this subscription.", "format": "uuid" }, "subscriptionType": { "enum": [ "Follow", "Expiry" ], "type": "string", "description": "The Type of this subscription." }, "subscriptionObjectType": { "enum": [ "Record", "Collection" ], "type": "string", "description": "The Type of this subscription object." }, "createdBy": { "type": "string", "description": "The creator id of this subscription", "format": "uuid" }, "modifiedBy": { "type": "string", "description": "The modifier id of this subscription", "format": "uuid" }, "createdOn": { "type": "string", "description": "The date when this subscription was created", "format": "date-time" }, "modifiedOn": { "type": "string", "description": "The date when this subscription was updated", "format": "date-time" }, "aprimoUserId": { "type": [ "null", "integer" ], "description": "The Aprimo User Id of this subscription.", "format": "int32" }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "A user's opt-in to be notified about changes to a specific object (e.g. a record or collection) - links a user, the object, and the kind of change they want to be notified about." }, "SubtitleResource": { "title": "Subtitle resource", "type": "object", "properties": { "subtitleDisplayName": { "type": "string", "description": "Display name of the subtitle file" }, "subtitleLanguageName": { "type": "string", "description": "Language name of the subtitle file" }, "subtitleLanguageCode": { "type": "string", "description": "Language code of the subtitle file" }, "subtitleIsTranscript": { "type": "string", "description": "Transcript flag of the subtitle file" }, "id": { "type": "string", "description": "Identifier for this additional file.", "format": "uuid" }, "type": { "description": "Type of this additional file. On the additional files collection endpoint, the results can be restricted to specific types with a \"select-additionalfile-type\" request header (comma-separated AdditionalFileType names).", "$ref": "#/components/schemas/AdditionalFileType" }, "isManual": { "type": "boolean", "description": "Returns true if this additional has been added manually. false is returned if the additional file was created automatically." }, "label": { "type": "string", "description": "Label of the additional file" }, "fileSize": { "type": "integer", "description": "File size of the additional file", "format": "int64" }, "fileName": { "type": "string", "description": "File name of the additional file" }, "extension": { "type": "string", "description": "File extension of the additional file" }, "tag": { "type": "string", "description": "Tag of the additional file Opt-in: returned only when requested. Include via a \"select-additionalfile: Tag\" header." }, "usages": { "type": "array", "items": { "type": "string" }, "description": "Usages of the additional file. On the additional files collection endpoint, the results can be restricted to specific usages with a \"select-additionalfile-usage\" request header (comma-separated values)." }, "uri": { "type": "string", "description": "Returns a path to image or if no image is assigned. This URL remains valid for four hours. Opt-in: returned only when requested. Include via a \"select-additionalfile: Uri\" header." }, "metadata": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Technical metadata specific to this additional file's type (e.g. video duration, image resolution). The available keys vary by file type and aren't individually documented. Opt-in: returned only when requested. Include via a \"select-additionalfile: Metadata\" header." }, "purposes": { "type": "array", "items": { "type": "string" }, "description": "Purposes of the additional file. On the additional files collection endpoint, the results can be restricted to specific purposes with a \"select-filter-purposes\" request header (comma-separated values)." }, "crc32": { "type": "integer", "description": "CRC32 checksum of this additional file.", "format": "int32" }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" }, "publicLink": { "description": "Relation to the addition file public link.", "$ref": "#/components/schemas/Link" }, "mainPreview": { "description": "Relation to an image of main preview with the size of a preview.", "$ref": "#/components/schemas/Link" }, "filePreviews": { "description": "Relation to a collection of file previews.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "publicLink": { "description": "Relation to the addition file public link. Embed via a \"select-additionalfile: publicLink\" header.", "$ref": "#/components/schemas/PublicLinkResource" }, "mainPreview": { "description": "Relation to an image of main preview with the size of a preview. Embed via a \"select-additionalfile: mainPreview\" header.", "$ref": "#/components/schemas/ImageResource" }, "filePreviews": { "description": "Relation to a collection of file previews. Embed via a \"select-additionalfile: filePreviews\" header.", "$ref": "#/components/schemas/AdditionalFilePreviewCollectionResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "Representation of a Subtitle File" }, "SuggestionNonResource": { "title": "Suggestion non resource", "type": "object", "properties": { "text": { "type": "string", "description": "Suggestion text" }, "score": { "type": "number", "description": "Suggestion score", "format": "double" } }, "description": "Represents a suggestion" }, "SuggestionRequestModel": { "title": "Suggestion request model", "type": "object", "properties": { "input": { "type": "string", "description": "Partial text typed by the user to get suggestions for." }, "fuzziness": { "type": "string", "description": "Fuzziness of the suggestion search, between 0.0 and 2.0. Interpreted as a Levenshtein edit distance - the number of one-character changes needed to make one string match another." }, "fieldIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Identifiers of the fields to generate suggestions from. Your Aprimo DAM installation must be configured so that these fields are included in the suggestion search engine indexing, via the .enterpriseSearchSuggestionConfiguration system setting." }, "languageIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Identifiers of the languages to search within." }, "numberOfSuggestions": { "type": [ "null", "integer" ], "description": "Maximum number of suggestions to return. Defaults to 5.", "format": "int32" } }, "description": "Represents a request for field-value suggestions (autocomplete)." }, "TextFieldFacetModel": { "title": "Text field facet model", "type": "object", "properties": { "maximumFacetValues": { "type": [ "null", "integer" ], "description": "Maximum number of facet values returned.", "format": "int32" }, "caseSensitive": { "type": [ "null", "boolean" ], "description": "Whether strings that only differ in case are aggregated into the same facet." }, "fieldId": { "type": [ "null", "string" ], "description": "The id of the field this facet should operate on.", "format": "uuid" }, "filters": { "type": "array", "items": { "type": "string" }, "description": "Filters allow you to limit the hits returned without affecting facets. If filters are specified, the aggregated counts in the facets remain the same. However, only records that match the filter criteria specified in the facet are returned. The parameter type of the filters depends on the facet type, but is always the same type as explicitValues/explicitRanges." }, "explicitValues": { "type": "array", "items": { "type": "string" }, "description": "A list of values. When specified, only shows facets corresponding to the specified values. If not specified, all occurring values are included." }, "explicitRanges": { "type": "array", "items": { "type": "string" }, "description": "Allows for the explicit specification of ranges to include in the facet. If explicitRanges is specified, you cannot specify rangeStart, rangeEnd, or spans (on the concrete range facet type)." }, "name": { "type": "string", "description": "A textual identifier for this facet, used only by the client to correlate requests with responses." }, "type": { "enum": [ "NumericField", "NumericFieldRange", "Classification", "CreatedBy", "ModifiedBy", "FileType", "OptionListField", "TextField", "DateTimeFieldRange", "DateFieldRange", "CreatedOn", "ModifiedOn", "TimeFieldRange", "TextListField", "ContentType", "ClassificationListField", "DateFieldRangeFilter", "NumericFieldRangeFilter" ], "type": "string", "description": "Type of the facet. Depending on facet type, different parameters, combinations of parameters and parameter types are possible." } }, "description": "Facets on a Text-type field's values. explicitValues is a list of strings." }, "TextListFieldDefinitionCreateCommand": { "title": "Text list field definition create command", "type": "object", "properties": { "aIEnabled": { "type": "boolean", "description": "When set to true, AI-based content generation is enabled for this field." }, "dataType": { "description": "Data type of the field definition. Determines which other properties apply.", "$ref": "#/components/schemas/FieldDefinitionType" }, "enabledLanguages": { "description": "Languages in which this field is enabled. Use AddOrUpdate to add or update members, or Remove to remove them.", "$ref": "#/components/schemas/EditableIdCollectionModel" }, "indexed": { "type": "boolean", "description": "When set to true, the field is indexed for search." }, "inlineStyle": { "type": "string", "description": "Inline CSS style applied to the field in the DAM UI." }, "isReadOnly": { "type": "boolean", "description": "When set to true, the field cannot be edited." }, "isRequired": { "type": "boolean", "description": "When set to true, the field is required." }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelModel" }, "description": "Multi-language labels for the name of this field." }, "languageMode": { "type": "string", "description": "Language mode of the field." }, "memberships": { "description": "Field groups this field is a member of. Use AddOrUpdate to add or update members, or Remove to remove them.", "$ref": "#/components/schemas/EditableIdCollectionModel" }, "name": { "type": "string", "description": "Name of the field." }, "scope": { "type": "string", "description": "Scope of the field." }, "sortIndex": { "type": "integer", "description": "Sort index used to order the field relative to other fields.", "format": "int32" }, "tag": { "type": "string", "description": "Tag associated with the field." }, "defaultValue": { "type": "string", "description": "Default value assigned to the field." }, "resetToDefaultTriggers": { "type": "array", "items": { "type": "string" }, "description": "Names of the triggers that reset the field to its default value." }, "resetToDefaultFields": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Ids of the fields that reset this field to its default value when they change." }, "validation": { "type": "string", "description": "Validation expression applied to the field value." }, "validationErrorMessage": { "type": "string", "description": "Error message shown when validation fails." }, "validationTrigger": { "type": "string", "description": "Trigger that determines when validation is applied." }, "storageMode": { "type": "string", "description": "Storage mode of the field." }, "helpTexts": { "type": "array", "items": { "$ref": "#/components/schemas/HelpTextModel" }, "description": "Multi-language help texts for this field." } }, "description": "Command to create a text list field definition." }, "TextListFieldDefinitionResource": { "title": "Text list field definition resource", "type": "object", "properties": { "aIEnabled": { "type": "boolean", "description": "Indicates whether to allow AI enhancement." }, "label": { "type": "string", "description": "Label of this field." }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelNonResource" }, "description": "A collection of Label items." }, "dataType": { "$ref": "#/components/schemas/FieldDataType" }, "scope": { "enum": [ "RecordContentGlobal", "RecordContentClassDependent", "RecordContentFloating", "ClassificationProfileClassDependent", "UserGlobal", "FileFileTypeDependent", "FileFloating", "IndexerTaskGlobal", "FileGlobal", "ClassificationProfileFloating", "RecordContentContentTypeDependent" ], "type": "string", "description": "Scope." }, "scopeCategory": { "enum": [ "Record", "File", "Classification", "User", "IndexerTask", "MetadataTemplate" ], "type": "string", "description": "Scope category." }, "indexed": { "type": "boolean", "description": "Indicator if searching on this field is enabled." }, "languageMode": { "enum": [ "Single", "Multiple" ], "type": "string", "description": "Language mode of the field." }, "memberships": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Memberships of a field." }, "searchIndexRebuildRequired": { "type": "boolean", "description": "Indicator if a search index rebuild is required." }, "enabledLanguages": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Enabled languages." }, "id": { "type": "string", "description": "Identifier for this field.", "format": "uuid" }, "name": { "type": "string", "description": "Name for this field." }, "isRequired": { "type": "boolean", "description": "Indicates whether this field is required." }, "isReadOnly": { "type": "boolean", "description": "Indicates whether this field is read only." }, "isUniqueIdentifier": { "type": "boolean", "description": "Indicates whether this field is a unique identifier." }, "inlineStyle": { "type": "string", "description": "Inline CSS style applied to this field." }, "sortIndex": { "type": "integer", "description": "Sorting index of this field.", "format": "int32" }, "tag": { "type": "string", "description": "Tag for this field containing extra information. Opt-in: returned only when requested. Include via a \"select-fielddefinition: Tag\" header." }, "createdOn": { "type": "string", "description": "Created on the specified date in UTC time", "format": "date-time" }, "modifiedOn": { "type": "string", "description": "Modified on the specified date in UTC time", "format": "date-time" }, "defaultValue": { "type": "string", "description": "Default value of this field." }, "resetToDefaultTriggers": { "type": "array", "items": { "enum": [ "None", "OnNewField", "OnLoad", "OnSave", "OnAnyFileChange", "OnReclassifyRecord", "OnAnyChange", "OnFieldChange", "OnMasterFileChange", "OnCurrentFileChange", "OnFieldDefinitionChanged", "OnDuplicateRecord", "OnRecordStatusChange" ], "type": "string" }, "description": "'reset to default triggers' value of this field." }, "validation": { "type": "string", "description": "Validation of this field." }, "validationErrorMessage": { "type": "string", "description": "Error message of this field." }, "validationTrigger": { "enum": [ "None", "WhenNeeded", "Always" ], "type": "string", "description": "Trigger that determines when validation is evaluated for this field." }, "storageMode": { "enum": [ "None", "NonEmptyValues", "AllValues", "LogChanges" ], "type": "string", "description": "Storage mode of this field." }, "resetToDefaultFields": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Fields that trigger this field to be reset back to its default value. This is only used if \"ResetToDefaultTriggers\" is set to \"OnFieldChange\"." }, "helpText": { "type": "string", "description": "Help text of this field." }, "helpTexts": { "type": "array", "items": { "$ref": "#/components/schemas/HelpTextNonResource" }, "description": "A collection of HelpText items." }, "_links": { "type": "object", "properties": { "createdBy": { "description": "Relation to the user who created this field definition.", "$ref": "#/components/schemas/Link" }, "modifiedBy": { "description": "Relation to the user who last modified this field definition.", "$ref": "#/components/schemas/Link" }, "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "createdBy": { "description": "Relation to the user who created this field definition. Embed via a \"select-fielddefinition: createdBy\" header.", "$ref": "#/components/schemas/UserResource" }, "modifiedBy": { "description": "Relation to the user who last modified this field definition. Embed via a \"select-fielddefinition: modifiedBy\" header.", "$ref": "#/components/schemas/UserResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "Representation of the definition of a text list field" }, "TextListFieldFacetModel": { "title": "Text list field facet model", "type": "object", "properties": { "maximumFacetValues": { "type": [ "null", "integer" ], "description": "Maximum number of facet values returned.", "format": "int32" }, "alwaysIncludeFiltersInFacetValues": { "type": [ "null", "boolean" ], "description": "Determines if the filters applied to this facet should always be part of the facet values. When maximumFacetValues is set and explicitValues is not and filters are applied, it is possible that the items being filtered on are not part of the facet values. Set this to true to prevent that. Defaults to false." }, "fieldId": { "type": [ "null", "string" ], "description": "The id of the field this facet should operate on.", "format": "uuid" }, "filters": { "type": "array", "items": { "type": "string" }, "description": "Filters allow you to limit the hits returned without affecting facets. If filters are specified, the aggregated counts in the facets remain the same. However, only records that match the filter criteria specified in the facet are returned. The parameter type of the filters depends on the facet type, but is always the same type as explicitValues/explicitRanges." }, "explicitValues": { "type": "array", "items": { "type": "string" }, "description": "A list of values. When specified, only shows facets corresponding to the specified values. If not specified, all occurring values are included." }, "explicitRanges": { "type": "array", "items": { "type": "string" }, "description": "Allows for the explicit specification of ranges to include in the facet. If explicitRanges is specified, you cannot specify rangeStart, rangeEnd, or spans (on the concrete range facet type)." }, "name": { "type": "string", "description": "A textual identifier for this facet, used only by the client to correlate requests with responses." }, "type": { "enum": [ "NumericField", "NumericFieldRange", "Classification", "CreatedBy", "ModifiedBy", "FileType", "OptionListField", "TextField", "DateTimeFieldRange", "DateFieldRange", "CreatedOn", "ModifiedOn", "TimeFieldRange", "TextListField", "ContentType", "ClassificationListField", "DateFieldRangeFilter", "NumericFieldRangeFilter" ], "type": "string", "description": "Type of the facet. Depending on facet type, different parameters, combinations of parameters and parameter types are possible." } }, "description": "Facets on a TextList-type field's option collection items. explicitValues is a list of string values." }, "TextListFieldResource": { "title": "Text list field resource", "type": "object", "properties": { "dataType": { "$ref": "#/components/schemas/FieldDataType" }, "fieldName": { "type": "string", "description": "Name of this field." }, "label": { "type": "string", "description": "Label of this field." }, "id": { "type": "string", "description": "Id of this field.", "format": "uuid" }, "localizedValues": { "type": "array", "items": { "$ref": "#/components/schemas/TextListFieldValues" }, "description": "Language specific data of this field." }, "inheritanceState": { "enum": [ "None", "Inherited" ], "type": [ "null", "string" ], "description": "Inheritance State of this field. Opt-in: returned only when requested. Include via a \"select-field: InheritanceState\" header." }, "inheritable": { "type": [ "null", "boolean" ], "description": "Whether the field value can be used as a parent in inheritance hierarchy. Opt-in: returned only when requested. Include via a \"select-field: Inheritable\" header." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" }, "definition": { "description": "Relation to the field definition.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "definition": { "description": "Relation to the field definition. Embed via a \"select-textlistfield: definition\" header.", "$ref": "#/components/schemas/FieldDefinitionResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "A list-of-text field value on a record, file, classification, or user, including its language-specific values." }, "TextListFieldValues": { "title": "Text list field values", "type": "object", "properties": { "values": { "type": "array", "items": { "type": "string" }, "description": "Language-specific collection of texts." }, "aIInfluenced": { "type": "boolean", "description": "Flag to indicate whether the value has come from AI." }, "languageId": { "type": "string", "description": "The language id.", "format": "uuid" }, "readOnly": { "type": [ "null", "boolean" ], "description": "Tells if the field is read-only." }, "modifiedOn": { "type": "string", "description": "Contains the date/time when the field is last modified.", "format": "date-time" } }, "description": "The collection of language-specific values stored in the TextList field." }, "TextSettingDefinitionCreateCommand": { "title": "Text setting definition create command", "type": "object", "properties": { "defaultValue": { "type": "string", "description": "Default value for this text setting definition." }, "regularExpression": { "type": "string", "description": "Regular expression used to validate the value of this setting definition." }, "dataType": { "description": "Data type of the setting definition to create. Determines which additional properties apply.", "$ref": "#/components/schemas/SettingDefinitionType" }, "name": { "type": "string", "description": "Name of this setting definition." }, "categoryId": { "type": "string", "description": "Id of the setting category this setting definition belongs to.", "format": "uuid" }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelModel" }, "description": "Multi-language labels for the name of this setting definition." }, "allowSystemSetting": { "type": "boolean", "description": "When set, allows this setting to be configured at the system level." }, "allowUserSetting": { "type": "boolean", "description": "When set, allows this setting to be configured at the user level." }, "roleRequiredForChange": { "type": "string", "description": "Name of the role required to change settings of this definition." }, "userGroupSettingMode": { "enum": [ "None", "MaximumValue", "MinimumValue", "Manual", "FirstValue" ], "type": "string", "description": "Algorithm used to calculate the effective value for user group settings of this definition." }, "helpUrl": { "type": "string", "description": "URL to help documentation for this setting definition." }, "tag": { "type": "string", "description": "Free-form tag for this setting definition." } }, "description": "Creates a new text setting definition." }, "TextSettingDefinitionResource": { "title": "Text setting definition resource", "type": "object", "properties": { "defaultValue": { "type": "string", "description": "Default value of the setting" }, "regularExpression": { "type": "string", "description": "Regular expression that the setting value should match" }, "id": { "type": "string", "description": "Id of the setting definition", "format": "uuid" }, "helpUrl": { "type": "string", "description": "Help url for the setting definition" }, "userGroupSettingMode": { "enum": [ "None", "MaximumValue", "MinimumValue", "Manual", "FirstValue" ], "type": "string", "description": "UserGroupSettingMode for the setting definition" }, "categoryId": { "type": "string", "description": "Category Id for the setting definition", "format": "uuid" }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelNonResource" }, "description": "Collection of labels for the setting definition" }, "allowSystemSetting": { "type": "boolean", "description": "Indicates whether this setting can be configured at the system level." }, "allowUserSetting": { "type": "boolean", "description": "Indicates whether this setting can be configured per user." }, "roleRequiredForChange": { "type": "string", "description": "Role that needs to be changed" }, "name": { "type": "string", "description": "Name of the setting definition" }, "dataType": { "enum": [ "None", "Boolean", "Text", "Numeric", "DateTime", "Xml", "Role", "Reference", "EncryptedText", "DefSchema" ], "type": "string", "description": "Data type of this setting" }, "tag": { "type": "string", "description": "Tag for this setting containing extra information. Opt-in: returned only when requested. Include via a \"select-settingdefinition: Tag\" header." }, "modifiedOn": { "type": "string", "description": "Last modification datetime in UTC time.", "format": "date-time" }, "createdOn": { "type": "string", "description": "Creation datetime in UTC time.", "format": "date-time" }, "_links": { "type": "object", "properties": { "modifiedBy": { "description": "Relation to the user who last modified this settingdefinition.", "$ref": "#/components/schemas/Link" }, "createdBy": { "description": "Relation to the user who created this settingdefinition.", "$ref": "#/components/schemas/Link" }, "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "modifiedBy": { "description": "Relation to the user who last modified this settingdefinition. Embed via a \"select-textsettingdefinition: modifiedBy\" header.", "$ref": "#/components/schemas/UserResource" }, "createdBy": { "description": "Relation to the user who created this settingdefinition. Embed via a \"select-textsettingdefinition: createdBy\" header.", "$ref": "#/components/schemas/UserResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "Representation of a text-based system setting definition." }, "ThreeDimensionalFileResource": { "title": "Three dimensional file resource", "type": "object", "properties": { "id": { "type": "string", "description": "Identifier for this additional file.", "format": "uuid" }, "type": { "description": "Type of this additional file. On the additional files collection endpoint, the results can be restricted to specific types with a \"select-additionalfile-type\" request header (comma-separated AdditionalFileType names).", "$ref": "#/components/schemas/AdditionalFileType" }, "isManual": { "type": "boolean", "description": "Returns true if this additional has been added manually. false is returned if the additional file was created automatically." }, "label": { "type": "string", "description": "Label of the additional file" }, "fileSize": { "type": "integer", "description": "File size of the additional file", "format": "int64" }, "fileName": { "type": "string", "description": "File name of the additional file" }, "extension": { "type": "string", "description": "File extension of the additional file" }, "tag": { "type": "string", "description": "Tag of the additional file Opt-in: returned only when requested. Include via a \"select-additionalfile: Tag\" header." }, "usages": { "type": "array", "items": { "type": "string" }, "description": "Usages of the additional file. On the additional files collection endpoint, the results can be restricted to specific usages with a \"select-additionalfile-usage\" request header (comma-separated values)." }, "uri": { "type": "string", "description": "Returns a path to image or if no image is assigned. This URL remains valid for four hours. Opt-in: returned only when requested. Include via a \"select-additionalfile: Uri\" header." }, "metadata": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Technical metadata specific to this additional file's type (e.g. video duration, image resolution). The available keys vary by file type and aren't individually documented. Opt-in: returned only when requested. Include via a \"select-additionalfile: Metadata\" header." }, "purposes": { "type": "array", "items": { "type": "string" }, "description": "Purposes of the additional file. On the additional files collection endpoint, the results can be restricted to specific purposes with a \"select-filter-purposes\" request header (comma-separated values)." }, "crc32": { "type": "integer", "description": "CRC32 checksum of this additional file.", "format": "int32" }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" }, "publicLink": { "description": "Relation to the addition file public link.", "$ref": "#/components/schemas/Link" }, "mainPreview": { "description": "Relation to an image of main preview with the size of a preview.", "$ref": "#/components/schemas/Link" }, "filePreviews": { "description": "Relation to a collection of file previews.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "publicLink": { "description": "Relation to the addition file public link. Embed via a \"select-additionalfile: publicLink\" header.", "$ref": "#/components/schemas/PublicLinkResource" }, "mainPreview": { "description": "Relation to an image of main preview with the size of a preview. Embed via a \"select-additionalfile: mainPreview\" header.", "$ref": "#/components/schemas/ImageResource" }, "filePreviews": { "description": "Relation to a collection of file previews. Embed via a \"select-additionalfile: filePreviews\" header.", "$ref": "#/components/schemas/AdditionalFilePreviewCollectionResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "Representation of a 3D additional file" }, "TimeFieldDefinitionCreateCommand": { "title": "Time field definition create command", "type": "object", "properties": { "timePattern": { "type": "string", "description": "Pattern used to format and parse the time value." }, "dataType": { "description": "Data type of the field definition. Determines which other properties apply.", "$ref": "#/components/schemas/FieldDefinitionType" }, "enabledLanguages": { "description": "Languages in which this field is enabled. Use AddOrUpdate to add or update members, or Remove to remove them.", "$ref": "#/components/schemas/EditableIdCollectionModel" }, "indexed": { "type": "boolean", "description": "When set to true, the field is indexed for search." }, "inlineStyle": { "type": "string", "description": "Inline CSS style applied to the field in the DAM UI." }, "isReadOnly": { "type": "boolean", "description": "When set to true, the field cannot be edited." }, "isRequired": { "type": "boolean", "description": "When set to true, the field is required." }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelModel" }, "description": "Multi-language labels for the name of this field." }, "languageMode": { "type": "string", "description": "Language mode of the field." }, "memberships": { "description": "Field groups this field is a member of. Use AddOrUpdate to add or update members, or Remove to remove them.", "$ref": "#/components/schemas/EditableIdCollectionModel" }, "name": { "type": "string", "description": "Name of the field." }, "scope": { "type": "string", "description": "Scope of the field." }, "sortIndex": { "type": "integer", "description": "Sort index used to order the field relative to other fields.", "format": "int32" }, "tag": { "type": "string", "description": "Tag associated with the field." }, "defaultValue": { "type": "string", "description": "Default value assigned to the field." }, "resetToDefaultTriggers": { "type": "array", "items": { "type": "string" }, "description": "Names of the triggers that reset the field to its default value." }, "resetToDefaultFields": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Ids of the fields that reset this field to its default value when they change." }, "validation": { "type": "string", "description": "Validation expression applied to the field value." }, "validationErrorMessage": { "type": "string", "description": "Error message shown when validation fails." }, "validationTrigger": { "type": "string", "description": "Trigger that determines when validation is applied." }, "storageMode": { "type": "string", "description": "Storage mode of the field." }, "helpTexts": { "type": "array", "items": { "$ref": "#/components/schemas/HelpTextModel" }, "description": "Multi-language help texts for this field." } }, "description": "Command to create a time field definition." }, "TimeFieldDefinitionResource": { "title": "Time field definition resource", "type": "object", "properties": { "timePattern": { "type": "string", "description": "The format the field only accepts and returns values in (e.g. \"hh:mm:ss\"). Unlike DateTime fields, values are not converted to the requesting user's time zone - if the time is zone-specific, include the zone in the field's label (e.g. \"Last Updated Time (PST)\") to avoid ambiguity." }, "label": { "type": "string", "description": "Label of this field." }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelNonResource" }, "description": "A collection of Label items." }, "dataType": { "$ref": "#/components/schemas/FieldDataType" }, "scope": { "enum": [ "RecordContentGlobal", "RecordContentClassDependent", "RecordContentFloating", "ClassificationProfileClassDependent", "UserGlobal", "FileFileTypeDependent", "FileFloating", "IndexerTaskGlobal", "FileGlobal", "ClassificationProfileFloating", "RecordContentContentTypeDependent" ], "type": "string", "description": "Scope." }, "scopeCategory": { "enum": [ "Record", "File", "Classification", "User", "IndexerTask", "MetadataTemplate" ], "type": "string", "description": "Scope category." }, "indexed": { "type": "boolean", "description": "Indicator if searching on this field is enabled." }, "languageMode": { "enum": [ "Single", "Multiple" ], "type": "string", "description": "Language mode of the field." }, "memberships": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Memberships of a field." }, "searchIndexRebuildRequired": { "type": "boolean", "description": "Indicator if a search index rebuild is required." }, "enabledLanguages": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Enabled languages." }, "id": { "type": "string", "description": "Identifier for this field.", "format": "uuid" }, "name": { "type": "string", "description": "Name for this field." }, "isRequired": { "type": "boolean", "description": "Indicates whether this field is required." }, "isReadOnly": { "type": "boolean", "description": "Indicates whether this field is read only." }, "isUniqueIdentifier": { "type": "boolean", "description": "Indicates whether this field is a unique identifier." }, "inlineStyle": { "type": "string", "description": "Inline CSS style applied to this field." }, "sortIndex": { "type": "integer", "description": "Sorting index of this field.", "format": "int32" }, "tag": { "type": "string", "description": "Tag for this field containing extra information. Opt-in: returned only when requested. Include via a \"select-fielddefinition: Tag\" header." }, "createdOn": { "type": "string", "description": "Created on the specified date in UTC time", "format": "date-time" }, "modifiedOn": { "type": "string", "description": "Modified on the specified date in UTC time", "format": "date-time" }, "defaultValue": { "type": "string", "description": "Default value of this field." }, "resetToDefaultTriggers": { "type": "array", "items": { "enum": [ "None", "OnNewField", "OnLoad", "OnSave", "OnAnyFileChange", "OnReclassifyRecord", "OnAnyChange", "OnFieldChange", "OnMasterFileChange", "OnCurrentFileChange", "OnFieldDefinitionChanged", "OnDuplicateRecord", "OnRecordStatusChange" ], "type": "string" }, "description": "'reset to default triggers' value of this field." }, "validation": { "type": "string", "description": "Validation of this field." }, "validationErrorMessage": { "type": "string", "description": "Error message of this field." }, "validationTrigger": { "enum": [ "None", "WhenNeeded", "Always" ], "type": "string", "description": "Trigger that determines when validation is evaluated for this field." }, "storageMode": { "enum": [ "None", "NonEmptyValues", "AllValues", "LogChanges" ], "type": "string", "description": "Storage mode of this field." }, "resetToDefaultFields": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Fields that trigger this field to be reset back to its default value. This is only used if \"ResetToDefaultTriggers\" is set to \"OnFieldChange\"." }, "helpText": { "type": "string", "description": "Help text of this field." }, "helpTexts": { "type": "array", "items": { "$ref": "#/components/schemas/HelpTextNonResource" }, "description": "A collection of HelpText items." }, "_links": { "type": "object", "properties": { "createdBy": { "description": "Relation to the user who created this field definition.", "$ref": "#/components/schemas/Link" }, "modifiedBy": { "description": "Relation to the user who last modified this field definition.", "$ref": "#/components/schemas/Link" }, "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "createdBy": { "description": "Relation to the user who created this field definition. Embed via a \"select-fielddefinition: createdBy\" header.", "$ref": "#/components/schemas/UserResource" }, "modifiedBy": { "description": "Relation to the user who last modified this field definition. Embed via a \"select-fielddefinition: modifiedBy\" header.", "$ref": "#/components/schemas/UserResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "Representation of the definition of a time field" }, "TimeFieldRangeFacetModel": { "title": "Time field range facet model", "type": "object", "properties": { "rangeStart": { "type": [ "null", "string" ], "description": "Start of the range to take into account. Cannot be specified if explicitRanges is specified." }, "rangeEnd": { "type": [ "null", "string" ], "description": "End of the range to take into account. Cannot be specified if explicitRanges is specified." }, "spans": { "type": "array", "items": { "type": "string" }, "description": "Allows for the explicit specification of spans to divide the facet into. If the range specified is larger than the sum of all spans, the last span is repeated to cover the entire range. Cannot be specified if explicitRanges is specified. If spans is specified, rangeStart and rangeEnd are mandatory." }, "boundaries": { "type": "array", "items": { "enum": [ "None", "Lower", "Upper", "Edge", "All" ], "type": "string" }, "description": "Specifies how to include hits that fall on range or span boundaries. Defaults to None." }, "fieldId": { "type": [ "null", "string" ], "description": "The id of the field this facet should operate on.", "format": "uuid" }, "filters": { "type": "array", "items": { "type": "string" }, "description": "Filters allow you to limit the hits returned without affecting facets. If filters are specified, the aggregated counts in the facets remain the same. However, only records that match the filter criteria specified in the facet are returned. The parameter type of the filters depends on the facet type, but is always the same type as explicitValues/explicitRanges." }, "explicitValues": { "type": "array", "items": { "type": "string" }, "description": "A list of values. When specified, only shows facets corresponding to the specified values. If not specified, all occurring values are included." }, "explicitRanges": { "type": "array", "items": { "type": "string" }, "description": "Allows for the explicit specification of ranges to include in the facet. If explicitRanges is specified, you cannot specify rangeStart, rangeEnd, or spans (on the concrete range facet type)." }, "name": { "type": "string", "description": "A textual identifier for this facet, used only by the client to correlate requests with responses." }, "type": { "enum": [ "NumericField", "NumericFieldRange", "Classification", "CreatedBy", "ModifiedBy", "FileType", "OptionListField", "TextField", "DateTimeFieldRange", "DateFieldRange", "CreatedOn", "ModifiedOn", "TimeFieldRange", "TextListField", "ContentType", "ClassificationListField", "DateFieldRangeFilter", "NumericFieldRangeFilter" ], "type": "string", "description": "Type of the facet. Depending on facet type, different parameters, combinations of parameters and parameter types are possible." } }, "description": "A range facet on a Time-type field's values. spans are also expressed as times." }, "TimeFieldResource": { "title": "Time field resource", "type": "object", "properties": { "dataType": { "$ref": "#/components/schemas/FieldDataType" }, "fieldName": { "type": "string", "description": "Name of this field." }, "label": { "type": "string", "description": "Label of this field." }, "id": { "type": "string", "description": "Id of this field.", "format": "uuid" }, "localizedValues": { "type": "array", "items": { "$ref": "#/components/schemas/TimeFieldValue" }, "description": "Language specific data of this field." }, "inheritanceState": { "enum": [ "None", "Inherited" ], "type": [ "null", "string" ], "description": "Inheritance State of this field. Opt-in: returned only when requested. Include via a \"select-field: InheritanceState\" header." }, "inheritable": { "type": [ "null", "boolean" ], "description": "Whether the field value can be used as a parent in inheritance hierarchy. Opt-in: returned only when requested. Include via a \"select-field: Inheritable\" header." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" }, "definition": { "description": "Relation to the field definition.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "definition": { "description": "Relation to the field definition. Embed via a \"select-timefield: definition\" header.", "$ref": "#/components/schemas/FieldDefinitionResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "Representation of a TimeField" }, "TimeFieldValue": { "title": "Time field value", "type": "object", "properties": { "value": { "type": "string", "description": "Time represented as a text in the following format: \"HH:mm:ss.fffffff\", but it will be stored with 1/1000 of second precision (.fff)" }, "languageId": { "type": "string", "description": "The language id.", "format": "uuid" }, "readOnly": { "type": [ "null", "boolean" ], "description": "Tells if the field is read-only." }, "modifiedOn": { "type": "string", "description": "Contains the date/time when the field is last modified.", "format": "date-time" } }, "description": "Language-specific TimeField value." }, "TitleConfigurationModel": { "title": "Title configuration model", "type": "object", "properties": { "option": { "enum": [ "FileName", "Field" ], "type": "string", "description": "Determines whether the title is resolved from the file name or from a field." }, "showExtension": { "type": "boolean", "description": "When set to true, the file extension is included in the title." }, "fieldId": { "type": "string", "description": "Id of the field used to resolve the title, when Option is set to use a field.", "format": "uuid" } }, "description": "Configuration that determines how the title of a record is resolved." }, "TranslateSubtitleActionParametersModel": { "title": "Translate subtitle action parameters model", "type": "object", "properties": { "subtitleId": { "type": "string", "description": "Id of the subtitle to translate.", "format": "uuid" }, "language": { "type": "string", "description": "Target language for the translation." }, "displayName": { "type": "string", "description": "Display name for the translated subtitle track." } }, "description": "Parameters for the \"TranslateSubtitle\" maintenance job action." }, "TranslationAgentFieldScope": { "title": "Translation agent field scope", "enum": [ "OnlyChangedFields", "AllSelectedFields" ], "type": "string", "x-enum-descriptions": [ "Translate only the field(s) that changed", "Translate all selected fields" ] }, "TranslationCreateCommand": { "title": "Translation create command", "type": "object", "properties": { "studio": { "type": "string", "description": "The studio the translation belongs to." }, "module": { "type": "string", "description": "The module the translation belongs to." }, "name": { "type": "string", "description": "The name of the translation." }, "tag": { "type": "string", "description": "A custom tag associated with the translation." }, "localizedValues": { "type": "array", "items": { "$ref": "#/components/schemas/TranslationItemModel" }, "description": "The localized values for the translation, one per language." } }, "description": "Command to create a translation." }, "TranslationEditCommand": { "title": "Translation edit command", "type": "object", "properties": { "studio": { "type": "string", "description": "The studio the translation belongs to." }, "module": { "type": "string", "description": "The module the translation belongs to." }, "name": { "type": "string", "description": "The name of the translation." }, "tag": { "type": "string", "description": "A custom tag associated with the translation." }, "localizedValues": { "type": "array", "items": { "$ref": "#/components/schemas/TranslationItemModel" }, "description": "The localized values for the translation, one per language." } }, "description": "Command to edit a translation." }, "TranslationItemModel": { "title": "Translation item model", "type": "object", "properties": { "value": { "type": "string", "description": "The translated text." }, "languageId": { "type": "string", "description": "The ID of the language this value is translated into.", "format": "uuid" } }, "description": "A single localized value for a translation." }, "TranslationItemNonResource": { "title": "Translation item non resource", "type": "object", "properties": { "languageId": { "type": "string", "description": "Item's language id.", "format": "uuid" }, "value": { "type": "string", "description": "Item's value." } }, "description": "Provides language-dependent item for the translation." }, "TranslationPagedCollectionResource": { "title": "Translation paged collection resource", "type": "object", "properties": { "pageNumber": { "type": [ "null", "integer" ], "description": "The current page of this paged collection.", "format": "int32" }, "pageSize": { "type": [ "null", "integer" ], "description": "The current page size of this paged collection.", "format": "int32" }, "skip": { "type": [ "null", "integer" ], "description": "The current skip size of this paged collection.", "format": "int32" }, "take": { "type": [ "null", "integer" ], "description": "The current take size of this paged collection.", "format": "int32" }, "totalCount": { "type": "integer", "description": "The total count of items in this paged collection, not just on the current page.", "format": "int64" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/TranslationResource" }, "description": "One page of this paged collection, which is a subcollection of the complete collection." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" }, "first": { "description": "A link to the first page of this paged collection.", "$ref": "#/components/schemas/Link" }, "prev": { "description": "A link to the previous page of this paged collection.", "$ref": "#/components/schemas/Link" }, "next": { "description": "A link to the next page of this paged collection.", "$ref": "#/components/schemas/Link" }, "last": { "description": "A link to the last page of this paged collection.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of a paged collection of translations." }, "TranslationResource": { "title": "Translation resource", "type": "object", "properties": { "id": { "type": "string", "description": "Translation identifier.", "format": "uuid" }, "studio": { "type": "string", "description": "Studio name for this translation." }, "module": { "type": "string", "description": "Module name for this translation." }, "name": { "type": "string", "description": "Name of the element that should be translated." }, "tag": { "type": "string", "description": "Value for the Tag of this object. The value of this property should be valid Xml. Opt-in: returned only when requested. Include via a \"select-translation: Tag\" header." }, "localizedValues": { "type": "array", "items": { "$ref": "#/components/schemas/TranslationItemNonResource" }, "description": "A collection of TranslationItem entities." }, "modifiedOn": { "type": "string", "description": "Last modification datetime in UTC time.", "format": "date-time" }, "createdOn": { "type": "string", "description": "Creation datetime in UTC time.", "format": "date-time" }, "_links": { "type": "object", "properties": { "modifiedBy": { "description": "Relation to the user who last modified this translation.", "$ref": "#/components/schemas/Link" }, "createdBy": { "description": "Relation to the user who created this translation.", "$ref": "#/components/schemas/Link" }, "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "modifiedBy": { "description": "Relation to the user who last modified this translation. Embed via a \"select-translation: modifiedBy\" header.", "$ref": "#/components/schemas/UserResource" }, "createdBy": { "description": "Relation to the user who created this translation. Embed via a \"select-translation: createdBy\" header.", "$ref": "#/components/schemas/UserResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "A localized text value (e.g. a UI label or field name) for a given translation key and language, used to support multi-language display in the DAM UI." }, "TrimRenditionResource": { "title": "Trim rendition resource", "type": "object", "properties": { "startTime": { "type": "string", "description": "The start time of the trim" }, "duration": { "type": "string", "description": "The duration of the trim" }, "id": { "type": "string", "description": "Identifier for the rendition", "format": "uuid" }, "uri": { "type": "string", "description": "Uri for this rendition Opt-in: returned only when requested. Include via a \"select-rendition: Uri\" header." }, "type": { "enum": [ "Original", "Preset", "Crop", "Trim", "Custom" ], "type": "string", "description": "Rendition type" }, "name": { "type": "string", "description": "Rendition name" }, "extension": { "type": "string", "description": "The extension of the rendition" }, "preview": { "type": "string", "description": "The preview of the rendition Opt-in: returned only when requested. Include via a \"select-rendition: Preview\" header." }, "publishedUri": { "type": "string", "description": "Shortcut property to the URI of the published public link of the rendition Opt-in: returned only when requested. Include via a \"select-rendition: PublishedUri\" header." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" }, "publicLinks": { "description": "Relation to the rendition public links.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "publicLinks": { "description": "Relation to the rendition public links. Embed via a \"select-rendition: publicLinks\" header.", "$ref": "#/components/schemas/PublicLinkCollectionResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "Representation of a rendition" }, "TrimResource": { "title": "Trim resource", "type": "object", "properties": { "preview": { "type": "string", "description": "The preview of the trim Opt-in: returned only when requested. Include via a \"select-additionalfile: Preview\" header." }, "startTime": { "type": "string", "description": "Start time of the trim." }, "duration": { "type": "string", "description": "Duration of the trim." }, "id": { "type": "string", "description": "Identifier for this additional file.", "format": "uuid" }, "type": { "description": "Type of this additional file. On the additional files collection endpoint, the results can be restricted to specific types with a \"select-additionalfile-type\" request header (comma-separated AdditionalFileType names).", "$ref": "#/components/schemas/AdditionalFileType" }, "isManual": { "type": "boolean", "description": "Returns true if this additional has been added manually. false is returned if the additional file was created automatically." }, "label": { "type": "string", "description": "Label of the additional file" }, "fileSize": { "type": "integer", "description": "File size of the additional file", "format": "int64" }, "fileName": { "type": "string", "description": "File name of the additional file" }, "extension": { "type": "string", "description": "File extension of the additional file" }, "tag": { "type": "string", "description": "Tag of the additional file Opt-in: returned only when requested. Include via a \"select-additionalfile: Tag\" header." }, "usages": { "type": "array", "items": { "type": "string" }, "description": "Usages of the additional file. On the additional files collection endpoint, the results can be restricted to specific usages with a \"select-additionalfile-usage\" request header (comma-separated values)." }, "uri": { "type": "string", "description": "Returns a path to image or if no image is assigned. This URL remains valid for four hours. Opt-in: returned only when requested. Include via a \"select-additionalfile: Uri\" header." }, "metadata": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Technical metadata specific to this additional file's type (e.g. video duration, image resolution). The available keys vary by file type and aren't individually documented. Opt-in: returned only when requested. Include via a \"select-additionalfile: Metadata\" header." }, "purposes": { "type": "array", "items": { "type": "string" }, "description": "Purposes of the additional file. On the additional files collection endpoint, the results can be restricted to specific purposes with a \"select-filter-purposes\" request header (comma-separated values)." }, "crc32": { "type": "integer", "description": "CRC32 checksum of this additional file.", "format": "int32" }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" }, "publicLink": { "description": "Relation to the addition file public link.", "$ref": "#/components/schemas/Link" }, "mainPreview": { "description": "Relation to an image of main preview with the size of a preview.", "$ref": "#/components/schemas/Link" }, "filePreviews": { "description": "Relation to a collection of file previews.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "publicLink": { "description": "Relation to the addition file public link. Embed via a \"select-additionalfile: publicLink\" header.", "$ref": "#/components/schemas/PublicLinkResource" }, "mainPreview": { "description": "Relation to an image of main preview with the size of a preview. Embed via a \"select-additionalfile: mainPreview\" header.", "$ref": "#/components/schemas/ImageResource" }, "filePreviews": { "description": "Relation to a collection of file previews. Embed via a \"select-additionalfile: filePreviews\" header.", "$ref": "#/components/schemas/AdditionalFilePreviewCollectionResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "Representation of a Trim" }, "TrimVideoActionParametersModel": { "title": "Trim video action parameters model", "type": "object", "properties": { "startTime": { "type": "string", "description": "Start time of the trimmed segment, as a TimeSpan-parseable string (e.g. \"00:00:05\")." }, "duration": { "type": "string", "description": "Duration of the trimmed segment, as a TimeSpan-parseable string." }, "trimmedVideoName": { "type": "string", "description": "Name for the resulting trimmed video file." } }, "description": "Parameters for the \"TrimVideo\" maintenance job action." }, "UnclassifyRecordActionParametersModel": { "title": "Unclassify record action parameters model", "type": "object", "properties": { "classificationId": { "type": "string", "description": "Id of the classification to remove from the record.", "format": "uuid" } }, "description": "Parameters for the \"UnclassifyRecord\" maintenance job action." }, "UnclassifyRecordRuleActionModel": { "title": "Unclassify record rule action model", "type": "object", "properties": { "reference": { "type": "string", "description": "A dynamic-value expression that resolves to a classification id or name path (depending on identifierType), used when gettingType is CalculatedByReference." }, "gettingType": { "description": "Controls how the classifications are specified: either with specific ids (Specified) or as the result of a reference (CalculatedByReference). See ClassificationGettingType.", "$ref": "#/components/schemas/ClassificationGettingType" }, "identifierType": { "description": "What reference resolves to when gettingType is CalculatedByReference: an id or a name path. See ClassificationIdentifierType.", "$ref": "#/components/schemas/ClassificationIdentifierType" }, "unlinkTarget": { "description": "Whether to unlink from the specified classifications themselves (classification) or from their descendants (classificationsDescendants). See UnlinkClassificationsTarget.", "$ref": "#/components/schemas/UnlinkClassificationsTarget" }, "classificationId": { "type": [ "null", "string" ], "description": "Id of the classification, used when gettingType is Specified.", "format": "uuid" }, "classificationIds": { "type": "array", "items": { "type": [ "null", "string" ], "format": "uuid" }, "description": "Ids of the classifications, used when gettingType is Specified." }, "index": { "type": "integer", "description": "Index of the action within the rule's action collection", "format": "int32" }, "actionType": { "description": "Type of action to be executed.", "$ref": "#/components/schemas/RuleActionDataType" }, "executionTime": { "description": "When the action should be executed.", "$ref": "#/components/schemas/RuleExecutionTime" } } }, "UnclassifyRecordRuleActionNonResource": { "title": "Unclassify record rule action non resource", "type": "object", "properties": { "reference": { "type": "string", "description": "A reference that results in a classification Id or name path, depending on the value of IdentifierType." }, "gettingType": { "description": "Controls how the classification is specified: either with a specific Id (Specified) or as a result of a reference (CalculatedByReference).", "$ref": "#/components/schemas/ClassificationGettingType" }, "identifierType": { "description": "Specify what is given as identification for the classification, in case GettingType is set to \"CalculatedByReference\". Possible values are Identifier or NamePath.", "$ref": "#/components/schemas/ClassificationIdentifierType" }, "unlinkTarget": { "description": "Specify which classifications will be unlinked", "$ref": "#/components/schemas/UnlinkClassificationsTarget" }, "classificationId": { "type": [ "null", "string" ], "description": "Specify the Id of the classification, in case GettingType is set to \"Specified\". In case ClassificationIds property is not null, current property is ignored", "format": "uuid" }, "classificationIds": { "type": "array", "items": { "type": [ "null", "string" ], "format": "uuid" }, "description": "Specify the Id of the many classifications, in case GettingType is set to \"Specified\". In case current property is not null, ClassificationId propetry is ignored" }, "index": { "type": "integer", "description": "Index of a rule action in collection", "format": "int32" }, "actionType": { "description": "Data type of this rule action", "$ref": "#/components/schemas/RuleActionDataType" }, "executionTime": { "description": "Execution time of the rule action", "$ref": "#/components/schemas/RuleExecutionTime" } }, "description": "Unlink target from the classification." }, "UniqueKeyIndexResource": { "title": "Unique key index resource", "type": "object", "properties": { "totalProcessedRecords": { "type": "integer", "description": "Total amount of processed records", "format": "int32" }, "totalProcessedClassifications": { "type": "integer", "description": "Total amount of processed classifications", "format": "int32" }, "isReindexing": { "type": "boolean", "description": "Is the reindexing process running?" }, "hasDuplicates": { "type": "boolean", "description": "Are duplicates present?" }, "indexBuildRequired": { "type": "boolean", "description": "Is a unique key index rebuild required?" }, "lastTimeIndexed": { "type": [ "null", "string" ], "description": "The last time an index happened", "format": "date-time" }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Status of the unique-key index, which enforces uniqueness for fields configured as unique keys across records and classifications - rebuild progress and duplicate detection." }, "UnlinkClassificationsTarget": { "title": "Unlink classifications target", "enum": [ "Classification", "ClassificationsDescendants" ], "type": "string", "x-enum-descriptions": [ "Unlink the classification itself", "Unlink the classification's descendants" ] }, "UpdateCheckCommand": { "title": "Update check command", "type": "object", "properties": { "name": { "type": "string", "description": "Name of the check." }, "actionTypeId": { "type": "string", "description": "Identifier of the action type associated with this check.", "format": "uuid" }, "checkCategoryId": { "type": "string", "description": "Identifier of the check category this check belongs to.", "format": "uuid" }, "isActive": { "type": "boolean", "description": "Whether the check is active. Defaults to true." }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelModel" }, "description": "Multi-language labels for this check" } }, "description": "Updates an existing check." }, "UpdateFileVersionCheckResultCommand": { "title": "Update file version check result command", "type": "object", "properties": { "description": { "type": "string", "description": "Description of the check result." }, "outcome": { "type": "string", "description": "Outcome of the check." } }, "description": "Updates an existing file version check result." }, "UpdateFileVersionCheckResultFindingCommand": { "title": "Update file version check result finding command", "type": "object", "properties": { "finding": { "type": "string", "description": "Description of the finding." }, "explanation": { "type": "string", "description": "Explanation of the finding." }, "recommendation": { "type": "string", "description": "Recommendation associated with the finding." }, "additionalData": { "type": "string", "description": "Additional data associated with the finding." }, "outcome": { "type": "string", "description": "Outcome of the finding." } }, "description": "Updates an existing finding on a file version check result." }, "UploadPreviewModel": { "title": "Upload preview model", "type": "object", "properties": { "fileName": { "type": "string", "description": "Name of the preview file." }, "name": { "type": "string", "description": "Name of the preview." }, "pageNumber": { "type": "integer", "description": "Page number the preview represents.", "format": "int32" } }, "description": "Describes a preview to generate for an uploaded file version." }, "UploadPreviewResource": { "title": "Upload preview resource", "type": "object", "properties": { "sasUrl": { "type": "string", "description": "SAS URL used to upload this preview directly to Azure Storage." } }, "description": "Provides data about preview within check in operation" }, "UseCDN": { "title": "Use CDN", "enum": [ "Automatic", "No" ], "type": "string" }, "UserFacetModel": { "title": "User facet model", "type": "object", "properties": { "maximumFacetValues": { "type": [ "null", "integer" ], "description": "Maximum number of facet values returned.", "format": "int32" }, "filters": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Filters allow you to limit the hits returned without affecting facets. If filters are specified, the aggregated counts in the facets remain the same. However, only records that match the filter criteria specified in the facet are returned. The parameter type of the filters depends on the facet type, but is always the same type as explicitValues/explicitRanges." }, "explicitValues": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "A list of values. When specified, only shows facets corresponding to the specified values. If not specified, all occurring values are included." }, "explicitRanges": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Allows for the explicit specification of ranges to include in the facet. If explicitRanges is specified, you cannot specify rangeStart, rangeEnd, or spans (on the concrete range facet type)." }, "name": { "type": "string", "description": "A textual identifier for this facet, used only by the client to correlate requests with responses." }, "type": { "enum": [ "NumericField", "NumericFieldRange", "Classification", "CreatedBy", "ModifiedBy", "FileType", "OptionListField", "TextField", "DateTimeFieldRange", "DateFieldRange", "CreatedOn", "ModifiedOn", "TimeFieldRange", "TextListField", "ContentType", "ClassificationListField", "DateFieldRangeFilter", "NumericFieldRangeFilter" ], "type": "string", "description": "Type of the facet. Depending on facet type, different parameters, combinations of parameters and parameter types are possible." } }, "description": "Facets on the user who created or modified the record (Type distinguishes which). explicitValues is a list of user ids." }, "UserGroupCollectionResource": { "title": "User group collection resource", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroupResource" }, "description": "A collection of resource items." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of a non-paged collection of user groups" }, "UserGroupListFieldDefinitionCreateCommand": { "title": "User group list field definition create command", "type": "object", "properties": { "filter": { "type": "string", "description": "Filter expression applied to restrict the available user groups." }, "dataType": { "description": "Data type of the field definition. Determines which other properties apply.", "$ref": "#/components/schemas/FieldDefinitionType" }, "enabledLanguages": { "description": "Languages in which this field is enabled. Use AddOrUpdate to add or update members, or Remove to remove them.", "$ref": "#/components/schemas/EditableIdCollectionModel" }, "indexed": { "type": "boolean", "description": "When set to true, the field is indexed for search." }, "inlineStyle": { "type": "string", "description": "Inline CSS style applied to the field in the DAM UI." }, "isReadOnly": { "type": "boolean", "description": "When set to true, the field cannot be edited." }, "isRequired": { "type": "boolean", "description": "When set to true, the field is required." }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelModel" }, "description": "Multi-language labels for the name of this field." }, "languageMode": { "type": "string", "description": "Language mode of the field." }, "memberships": { "description": "Field groups this field is a member of. Use AddOrUpdate to add or update members, or Remove to remove them.", "$ref": "#/components/schemas/EditableIdCollectionModel" }, "name": { "type": "string", "description": "Name of the field." }, "scope": { "type": "string", "description": "Scope of the field." }, "sortIndex": { "type": "integer", "description": "Sort index used to order the field relative to other fields.", "format": "int32" }, "tag": { "type": "string", "description": "Tag associated with the field." }, "defaultValue": { "type": "string", "description": "Default value assigned to the field." }, "resetToDefaultTriggers": { "type": "array", "items": { "type": "string" }, "description": "Names of the triggers that reset the field to its default value." }, "resetToDefaultFields": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Ids of the fields that reset this field to its default value when they change." }, "validation": { "type": "string", "description": "Validation expression applied to the field value." }, "validationErrorMessage": { "type": "string", "description": "Error message shown when validation fails." }, "validationTrigger": { "type": "string", "description": "Trigger that determines when validation is applied." }, "storageMode": { "type": "string", "description": "Storage mode of the field." }, "helpTexts": { "type": "array", "items": { "$ref": "#/components/schemas/HelpTextModel" }, "description": "Multi-language help texts for this field." } }, "description": "Command to create a user group list field definition." }, "UserGroupListFieldDefinitionResource": { "title": "User group list field definition resource", "type": "object", "properties": { "filter": { "type": "string", "description": "Filter of this field." }, "label": { "type": "string", "description": "Label of this field." }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelNonResource" }, "description": "A collection of Label items." }, "dataType": { "$ref": "#/components/schemas/FieldDataType" }, "scope": { "enum": [ "RecordContentGlobal", "RecordContentClassDependent", "RecordContentFloating", "ClassificationProfileClassDependent", "UserGlobal", "FileFileTypeDependent", "FileFloating", "IndexerTaskGlobal", "FileGlobal", "ClassificationProfileFloating", "RecordContentContentTypeDependent" ], "type": "string", "description": "Scope." }, "scopeCategory": { "enum": [ "Record", "File", "Classification", "User", "IndexerTask", "MetadataTemplate" ], "type": "string", "description": "Scope category." }, "indexed": { "type": "boolean", "description": "Indicator if searching on this field is enabled." }, "languageMode": { "enum": [ "Single", "Multiple" ], "type": "string", "description": "Language mode of the field." }, "memberships": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Memberships of a field." }, "searchIndexRebuildRequired": { "type": "boolean", "description": "Indicator if a search index rebuild is required." }, "enabledLanguages": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Enabled languages." }, "id": { "type": "string", "description": "Identifier for this field.", "format": "uuid" }, "name": { "type": "string", "description": "Name for this field." }, "isRequired": { "type": "boolean", "description": "Indicates whether this field is required." }, "isReadOnly": { "type": "boolean", "description": "Indicates whether this field is read only." }, "isUniqueIdentifier": { "type": "boolean", "description": "Indicates whether this field is a unique identifier." }, "inlineStyle": { "type": "string", "description": "Inline CSS style applied to this field." }, "sortIndex": { "type": "integer", "description": "Sorting index of this field.", "format": "int32" }, "tag": { "type": "string", "description": "Tag for this field containing extra information. Opt-in: returned only when requested. Include via a \"select-fielddefinition: Tag\" header." }, "createdOn": { "type": "string", "description": "Created on the specified date in UTC time", "format": "date-time" }, "modifiedOn": { "type": "string", "description": "Modified on the specified date in UTC time", "format": "date-time" }, "defaultValue": { "type": "string", "description": "Default value of this field." }, "resetToDefaultTriggers": { "type": "array", "items": { "enum": [ "None", "OnNewField", "OnLoad", "OnSave", "OnAnyFileChange", "OnReclassifyRecord", "OnAnyChange", "OnFieldChange", "OnMasterFileChange", "OnCurrentFileChange", "OnFieldDefinitionChanged", "OnDuplicateRecord", "OnRecordStatusChange" ], "type": "string" }, "description": "'reset to default triggers' value of this field." }, "validation": { "type": "string", "description": "Validation of this field." }, "validationErrorMessage": { "type": "string", "description": "Error message of this field." }, "validationTrigger": { "enum": [ "None", "WhenNeeded", "Always" ], "type": "string", "description": "Trigger that determines when validation is evaluated for this field." }, "storageMode": { "enum": [ "None", "NonEmptyValues", "AllValues", "LogChanges" ], "type": "string", "description": "Storage mode of this field." }, "resetToDefaultFields": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Fields that trigger this field to be reset back to its default value. This is only used if \"ResetToDefaultTriggers\" is set to \"OnFieldChange\"." }, "helpText": { "type": "string", "description": "Help text of this field." }, "helpTexts": { "type": "array", "items": { "$ref": "#/components/schemas/HelpTextNonResource" }, "description": "A collection of HelpText items." }, "_links": { "type": "object", "properties": { "createdBy": { "description": "Relation to the user who created this field definition.", "$ref": "#/components/schemas/Link" }, "modifiedBy": { "description": "Relation to the user who last modified this field definition.", "$ref": "#/components/schemas/Link" }, "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "createdBy": { "description": "Relation to the user who created this field definition. Embed via a \"select-fielddefinition: createdBy\" header.", "$ref": "#/components/schemas/UserResource" }, "modifiedBy": { "description": "Relation to the user who last modified this field definition. Embed via a \"select-fielddefinition: modifiedBy\" header.", "$ref": "#/components/schemas/UserResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "Representation of the definition of a user group list field" }, "UserGroupListFieldItemResource": { "title": "User group list field item resource", "type": "object", "properties": { "id": { "type": "string", "description": "Id of this user group.", "format": "uuid" }, "name": { "type": "string", "description": "Name of the user group" }, "organizationId": { "type": "string", "description": "Organization associated with this user group", "format": "uuid" }, "tag": { "type": "string", "description": "Value for the Tag of this object. The value of this property should be valid Xml. Opt-in: returned only when requested. Include via a \"select-usergroup: Tag\" header." }, "isActive": { "type": "boolean", "description": "Whether the user group is still active or not." }, "modifiedOn": { "type": "string", "description": "Last modification datetime in UTC time.", "format": "date-time" }, "createdOn": { "type": "string", "description": "Creation datetime in UTC time.", "format": "date-time" }, "_links": { "type": "object", "properties": { "permissions": { "description": "Relation to the collection of all the Permissions that this userGroup has.", "$ref": "#/components/schemas/Link" }, "modifiedBy": { "description": "Relation to the user who last modified this user group.", "$ref": "#/components/schemas/Link" }, "createdBy": { "description": "Relation to the user who created this user group.", "$ref": "#/components/schemas/Link" }, "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "permissions": { "description": "Relation to the collection of all the Permissions that this userGroup has. Embed via a \"select-usergroup: permissions\" header.", "$ref": "#/components/schemas/PermissionValueCollectionResource" }, "modifiedBy": { "description": "Relation to the user who last modified this user group. Embed via a \"select-usergrouplistfielditem: modifiedBy\" header.", "$ref": "#/components/schemas/UserResource" }, "createdBy": { "description": "Relation to the user who created this user group. Embed via a \"select-usergrouplistfielditem: createdBy\" header.", "$ref": "#/components/schemas/UserResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "Representation of a User Group as a possible filtered value for a UserGroupListField" }, "UserGroupListFieldResource": { "title": "User group list field resource", "type": "object", "properties": { "dataType": { "$ref": "#/components/schemas/FieldDataType" }, "fieldName": { "type": "string", "description": "Name of this field." }, "label": { "type": "string", "description": "Label of this field." }, "id": { "type": "string", "description": "Id of this field.", "format": "uuid" }, "localizedValues": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroupListFieldValues" }, "description": "Language specific data of this field." }, "inheritanceState": { "enum": [ "None", "Inherited" ], "type": [ "null", "string" ], "description": "Inheritance State of this field. Opt-in: returned only when requested. Include via a \"select-field: InheritanceState\" header." }, "inheritable": { "type": [ "null", "boolean" ], "description": "Whether the field value can be used as a parent in inheritance hierarchy. Opt-in: returned only when requested. Include via a \"select-field: Inheritable\" header." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" }, "definition": { "description": "Relation to the field definition.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "definition": { "description": "Relation to the field definition. Embed via a \"select-usergrouplistfield: definition\" header.", "$ref": "#/components/schemas/FieldDefinitionResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "Representation of a UserGroupListField" }, "UserGroupListFieldValues": { "title": "User group list field values", "type": "object", "properties": { "values": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Language-specific collection of UserGroup Ids (represented as GUID values)." }, "languageId": { "type": "string", "description": "The language id.", "format": "uuid" }, "readOnly": { "type": [ "null", "boolean" ], "description": "Tells if the field is read-only." }, "modifiedOn": { "type": "string", "description": "Contains the date/time when the field is last modified.", "format": "date-time" } }, "description": "The collection of language-specific values stored in the UserGroupList field." }, "UserGroupPagedCollectionResource": { "title": "User group paged collection resource", "type": "object", "properties": { "pageNumber": { "type": [ "null", "integer" ], "description": "The current page of this paged collection.", "format": "int32" }, "pageSize": { "type": [ "null", "integer" ], "description": "The current page size of this paged collection.", "format": "int32" }, "skip": { "type": [ "null", "integer" ], "description": "The current skip size of this paged collection.", "format": "int32" }, "take": { "type": [ "null", "integer" ], "description": "The current take size of this paged collection.", "format": "int32" }, "totalCount": { "type": "integer", "description": "The total count of items in this paged collection, not just on the current page.", "format": "int64" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroupResource" }, "description": "One page of this paged collection, which is a subcollection of the complete collection." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" }, "first": { "description": "A link to the first page of this paged collection.", "$ref": "#/components/schemas/Link" }, "prev": { "description": "A link to the previous page of this paged collection.", "$ref": "#/components/schemas/Link" }, "next": { "description": "A link to the next page of this paged collection.", "$ref": "#/components/schemas/Link" }, "last": { "description": "A link to the last page of this paged collection.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of a paged collection of user groups" }, "UserGroupPermissionBatchEditCommand": { "title": "User group permission batch edit command", "type": "object", "properties": { "userGroups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroupPermissionUpdateModel" }, "description": "Collection of user groups with their permissions to update." } }, "description": "Command to update permissions for multiple user groups in a single operation." }, "UserGroupPermissionEditCommand": { "title": "User group permission edit command", "type": "object", "properties": { "permissions": { "description": "The permissions to update for this user group.", "$ref": "#/components/schemas/PermissionCollectionModel" } }, "description": "Command to update permissions for a single user group." }, "UserGroupPermissionUpdateModel": { "title": "User group permission update model", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the user group to update permissions for.", "format": "uuid" }, "permissions": { "description": "The permissions to update for this user group.", "$ref": "#/components/schemas/PermissionCollectionModel" } }, "description": "Model representing a user group and its permissions to update." }, "UserGroupResource": { "title": "User group resource", "type": "object", "properties": { "id": { "type": "string", "description": "Id of this user group.", "format": "uuid" }, "name": { "type": "string", "description": "Name of the user group" }, "organizationId": { "type": "string", "description": "Organization associated with this user group", "format": "uuid" }, "tag": { "type": "string", "description": "Value for the Tag of this object. The value of this property should be valid Xml. Opt-in: returned only when requested. Include via a \"select-usergroup: Tag\" header." }, "isActive": { "type": "boolean", "description": "Whether the user group is still active or not." }, "modifiedOn": { "type": "string", "description": "Last modification datetime in UTC time.", "format": "date-time" }, "createdOn": { "type": "string", "description": "Creation datetime in UTC time.", "format": "date-time" }, "_links": { "type": "object", "properties": { "permissions": { "description": "Relation to the collection of all the Permissions that this userGroup has.", "$ref": "#/components/schemas/Link" }, "modifiedBy": { "description": "Relation to the user who last modified this user group.", "$ref": "#/components/schemas/Link" }, "createdBy": { "description": "Relation to the user who created this user group.", "$ref": "#/components/schemas/Link" }, "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "permissions": { "description": "Relation to the collection of all the Permissions that this userGroup has. Embed via a \"select-usergroup: permissions\" header.", "$ref": "#/components/schemas/PermissionValueCollectionResource" }, "modifiedBy": { "description": "Relation to the user who last modified this user group. Embed via a \"select-usergroup: modifiedBy\" header.", "$ref": "#/components/schemas/UserResource" }, "createdBy": { "description": "Relation to the user who created this user group. Embed via a \"select-usergroup: createdBy\" header.", "$ref": "#/components/schemas/UserResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "A named collection of users, used to grant permissions or access lists to many users at once instead of assigning them individually." }, "UserListFieldDefinitionCreateCommand": { "title": "User list field definition create command", "type": "object", "properties": { "filter": { "type": "string", "description": "Filter expression applied to restrict the available users." }, "dataType": { "description": "Data type of the field definition. Determines which other properties apply.", "$ref": "#/components/schemas/FieldDefinitionType" }, "enabledLanguages": { "description": "Languages in which this field is enabled. Use AddOrUpdate to add or update members, or Remove to remove them.", "$ref": "#/components/schemas/EditableIdCollectionModel" }, "indexed": { "type": "boolean", "description": "When set to true, the field is indexed for search." }, "inlineStyle": { "type": "string", "description": "Inline CSS style applied to the field in the DAM UI." }, "isReadOnly": { "type": "boolean", "description": "When set to true, the field cannot be edited." }, "isRequired": { "type": "boolean", "description": "When set to true, the field is required." }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelModel" }, "description": "Multi-language labels for the name of this field." }, "languageMode": { "type": "string", "description": "Language mode of the field." }, "memberships": { "description": "Field groups this field is a member of. Use AddOrUpdate to add or update members, or Remove to remove them.", "$ref": "#/components/schemas/EditableIdCollectionModel" }, "name": { "type": "string", "description": "Name of the field." }, "scope": { "type": "string", "description": "Scope of the field." }, "sortIndex": { "type": "integer", "description": "Sort index used to order the field relative to other fields.", "format": "int32" }, "tag": { "type": "string", "description": "Tag associated with the field." }, "defaultValue": { "type": "string", "description": "Default value assigned to the field." }, "resetToDefaultTriggers": { "type": "array", "items": { "type": "string" }, "description": "Names of the triggers that reset the field to its default value." }, "resetToDefaultFields": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Ids of the fields that reset this field to its default value when they change." }, "validation": { "type": "string", "description": "Validation expression applied to the field value." }, "validationErrorMessage": { "type": "string", "description": "Error message shown when validation fails." }, "validationTrigger": { "type": "string", "description": "Trigger that determines when validation is applied." }, "storageMode": { "type": "string", "description": "Storage mode of the field." }, "helpTexts": { "type": "array", "items": { "$ref": "#/components/schemas/HelpTextModel" }, "description": "Multi-language help texts for this field." } }, "description": "Command to create a user list field definition." }, "UserListFieldDefinitionResource": { "title": "User list field definition resource", "type": "object", "properties": { "filter": { "type": "string", "description": "Filter of this field." }, "label": { "type": "string", "description": "Label of this field." }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelNonResource" }, "description": "A collection of Label items." }, "dataType": { "$ref": "#/components/schemas/FieldDataType" }, "scope": { "enum": [ "RecordContentGlobal", "RecordContentClassDependent", "RecordContentFloating", "ClassificationProfileClassDependent", "UserGlobal", "FileFileTypeDependent", "FileFloating", "IndexerTaskGlobal", "FileGlobal", "ClassificationProfileFloating", "RecordContentContentTypeDependent" ], "type": "string", "description": "Scope." }, "scopeCategory": { "enum": [ "Record", "File", "Classification", "User", "IndexerTask", "MetadataTemplate" ], "type": "string", "description": "Scope category." }, "indexed": { "type": "boolean", "description": "Indicator if searching on this field is enabled." }, "languageMode": { "enum": [ "Single", "Multiple" ], "type": "string", "description": "Language mode of the field." }, "memberships": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Memberships of a field." }, "searchIndexRebuildRequired": { "type": "boolean", "description": "Indicator if a search index rebuild is required." }, "enabledLanguages": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Enabled languages." }, "id": { "type": "string", "description": "Identifier for this field.", "format": "uuid" }, "name": { "type": "string", "description": "Name for this field." }, "isRequired": { "type": "boolean", "description": "Indicates whether this field is required." }, "isReadOnly": { "type": "boolean", "description": "Indicates whether this field is read only." }, "isUniqueIdentifier": { "type": "boolean", "description": "Indicates whether this field is a unique identifier." }, "inlineStyle": { "type": "string", "description": "Inline CSS style applied to this field." }, "sortIndex": { "type": "integer", "description": "Sorting index of this field.", "format": "int32" }, "tag": { "type": "string", "description": "Tag for this field containing extra information. Opt-in: returned only when requested. Include via a \"select-fielddefinition: Tag\" header." }, "createdOn": { "type": "string", "description": "Created on the specified date in UTC time", "format": "date-time" }, "modifiedOn": { "type": "string", "description": "Modified on the specified date in UTC time", "format": "date-time" }, "defaultValue": { "type": "string", "description": "Default value of this field." }, "resetToDefaultTriggers": { "type": "array", "items": { "enum": [ "None", "OnNewField", "OnLoad", "OnSave", "OnAnyFileChange", "OnReclassifyRecord", "OnAnyChange", "OnFieldChange", "OnMasterFileChange", "OnCurrentFileChange", "OnFieldDefinitionChanged", "OnDuplicateRecord", "OnRecordStatusChange" ], "type": "string" }, "description": "'reset to default triggers' value of this field." }, "validation": { "type": "string", "description": "Validation of this field." }, "validationErrorMessage": { "type": "string", "description": "Error message of this field." }, "validationTrigger": { "enum": [ "None", "WhenNeeded", "Always" ], "type": "string", "description": "Trigger that determines when validation is evaluated for this field." }, "storageMode": { "enum": [ "None", "NonEmptyValues", "AllValues", "LogChanges" ], "type": "string", "description": "Storage mode of this field." }, "resetToDefaultFields": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Fields that trigger this field to be reset back to its default value. This is only used if \"ResetToDefaultTriggers\" is set to \"OnFieldChange\"." }, "helpText": { "type": "string", "description": "Help text of this field." }, "helpTexts": { "type": "array", "items": { "$ref": "#/components/schemas/HelpTextNonResource" }, "description": "A collection of HelpText items." }, "_links": { "type": "object", "properties": { "createdBy": { "description": "Relation to the user who created this field definition.", "$ref": "#/components/schemas/Link" }, "modifiedBy": { "description": "Relation to the user who last modified this field definition.", "$ref": "#/components/schemas/Link" }, "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "createdBy": { "description": "Relation to the user who created this field definition. Embed via a \"select-fielddefinition: createdBy\" header.", "$ref": "#/components/schemas/UserResource" }, "modifiedBy": { "description": "Relation to the user who last modified this field definition. Embed via a \"select-fielddefinition: modifiedBy\" header.", "$ref": "#/components/schemas/UserResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "Representation of the definition of a user list field" }, "UserListFieldItemResource": { "title": "User list field item resource", "type": "object", "properties": { "id": { "type": "string", "description": "Id of this user.", "format": "uuid" }, "email": { "type": "string", "description": "Email address of this user. The email address is not required and has a maximum length of 254 characters." }, "languageId": { "type": "string", "description": "Default language used by this user when accessing fields.", "format": "uuid" }, "languageForUIId": { "type": "string", "description": "Default language used by this user for the static text displayed on the user interfaces.", "format": "uuid" }, "name": { "type": "string", "description": "Name of this user. This name is required, has to be unique, is not case sensitive and has a maximum length of 50 characters." }, "firstName": { "type": "string", "description": "First name of this user. This first name is not required and has a maximum length of 200 characters." }, "lastName": { "type": "string", "description": "Last name of this user. This last name is not required and has a maximum length of 200 characters." }, "imageUri": { "type": "string", "description": "URI of the image of this user." }, "tag": { "type": "string", "description": "Value for the Tag of this object. The value of this property should be valid Xml. Opt-in: returned only when requested. Include via a \"select-user: Tag\" header." }, "aprimoUserId": { "type": "integer", "description": "Numeric identifier of the linked Aprimo user account, distinct from this resource's GUID id.", "format": "int32" }, "isActive": { "type": "boolean", "description": "Whether the user is still active or not." }, "modifiedOn": { "type": "string", "description": "Last modification datetime in UTC time.", "format": "date-time" }, "createdOn": { "type": "string", "description": "Creation datetime in UTC time.", "format": "date-time" }, "_links": { "type": "object", "properties": { "fields": { "description": "Relation to a collection of fields.", "$ref": "#/components/schemas/Link" }, "memberships": { "description": "Relation to the collection of all the UserGroups that this user is member of.", "$ref": "#/components/schemas/Link" }, "permissions": { "description": "Relation to the collection of all the Permissions that this user has.", "$ref": "#/components/schemas/Link" }, "image": { "description": "Relation to an image with the picture of the user.", "$ref": "#/components/schemas/Link" }, "modifiedBy": { "description": "Relation to the user who last modified this user.", "$ref": "#/components/schemas/Link" }, "createdBy": { "description": "Relation to the user who created this user.", "$ref": "#/components/schemas/Link" }, "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "fields": { "description": "Relation to a collection of fields. Embed via a \"select-user: fields\" header.", "$ref": "#/components/schemas/FieldCollectionResource" }, "memberships": { "description": "Relation to the collection of all the UserGroups that this user is member of. Embed via a \"select-user: memberships\" header.", "$ref": "#/components/schemas/UserGroupCollectionResource" }, "permissions": { "description": "Relation to the collection of all the Permissions that this user has. Embed via a \"select-user: permissions\" header.", "$ref": "#/components/schemas/PermissionValueCollectionResource" }, "image": { "description": "Relation to an image with the picture of the user. Embed via a \"select-user: image\" header.", "$ref": "#/components/schemas/ImageResource" }, "modifiedBy": { "description": "Relation to the user who last modified this user. Embed via a \"select-userlistfielditem: modifiedBy\" header.", "$ref": "#/components/schemas/UserResource" }, "createdBy": { "description": "Relation to the user who created this user. Embed via a \"select-userlistfielditem: createdBy\" header.", "$ref": "#/components/schemas/UserResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "Representation of a User as a possible filtered value for a UserListField" }, "UserListFieldResource": { "title": "User list field resource", "type": "object", "properties": { "dataType": { "$ref": "#/components/schemas/FieldDataType" }, "fieldName": { "type": "string", "description": "Name of this field." }, "label": { "type": "string", "description": "Label of this field." }, "id": { "type": "string", "description": "Id of this field.", "format": "uuid" }, "localizedValues": { "type": "array", "items": { "$ref": "#/components/schemas/UserListFieldValues" }, "description": "Language specific data of this field." }, "inheritanceState": { "enum": [ "None", "Inherited" ], "type": [ "null", "string" ], "description": "Inheritance State of this field. Opt-in: returned only when requested. Include via a \"select-field: InheritanceState\" header." }, "inheritable": { "type": [ "null", "boolean" ], "description": "Whether the field value can be used as a parent in inheritance hierarchy. Opt-in: returned only when requested. Include via a \"select-field: Inheritable\" header." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" }, "definition": { "description": "Relation to the field definition.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "definition": { "description": "Relation to the field definition. Embed via a \"select-userlistfield: definition\" header.", "$ref": "#/components/schemas/FieldDefinitionResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "Representation of a UserListField" }, "UserListFieldValues": { "title": "User list field values", "type": "object", "properties": { "values": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Language-specific collection of user Ids (represented as GUID values)." }, "languageId": { "type": "string", "description": "The language id.", "format": "uuid" }, "readOnly": { "type": [ "null", "boolean" ], "description": "Tells if the field is read-only." }, "modifiedOn": { "type": "string", "description": "Contains the date/time when the field is last modified.", "format": "date-time" } }, "description": "The collection of language-specific values stored in the UserList field." }, "UserPagedCollectionResource": { "title": "User paged collection resource", "type": "object", "properties": { "pageNumber": { "type": [ "null", "integer" ], "description": "The current page of this paged collection.", "format": "int32" }, "pageSize": { "type": [ "null", "integer" ], "description": "The current page size of this paged collection.", "format": "int32" }, "skip": { "type": [ "null", "integer" ], "description": "The current skip size of this paged collection.", "format": "int32" }, "take": { "type": [ "null", "integer" ], "description": "The current take size of this paged collection.", "format": "int32" }, "totalCount": { "type": "integer", "description": "The total count of items in this paged collection, not just on the current page.", "format": "int64" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/UserResource" }, "description": "One page of this paged collection, which is a subcollection of the complete collection." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" }, "first": { "description": "A link to the first page of this paged collection.", "$ref": "#/components/schemas/Link" }, "prev": { "description": "A link to the previous page of this paged collection.", "$ref": "#/components/schemas/Link" }, "next": { "description": "A link to the next page of this paged collection.", "$ref": "#/components/schemas/Link" }, "last": { "description": "A link to the last page of this paged collection.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of a paged collection of users" }, "UserPermissionEditCommand": { "title": "User permission edit command", "type": "object", "properties": { "permissions": { "description": "The permissions to update for this user.", "$ref": "#/components/schemas/PermissionCollectionModel" } }, "description": "Command to update permissions for a single user." }, "UserResource": { "title": "User resource", "type": "object", "properties": { "id": { "type": "string", "description": "Id of this user.", "format": "uuid" }, "email": { "type": "string", "description": "Email address of this user. The email address is not required and has a maximum length of 254 characters." }, "languageId": { "type": "string", "description": "Default language used by this user when accessing fields.", "format": "uuid" }, "languageForUIId": { "type": "string", "description": "Default language used by this user for the static text displayed on the user interfaces.", "format": "uuid" }, "name": { "type": "string", "description": "Name of this user. This name is required, has to be unique, is not case sensitive and has a maximum length of 50 characters." }, "firstName": { "type": "string", "description": "First name of this user. This first name is not required and has a maximum length of 200 characters." }, "lastName": { "type": "string", "description": "Last name of this user. This last name is not required and has a maximum length of 200 characters." }, "imageUri": { "type": "string", "description": "URI of the image of this user." }, "tag": { "type": "string", "description": "Value for the Tag of this object. The value of this property should be valid Xml. Opt-in: returned only when requested. Include via a \"select-user: Tag\" header." }, "aprimoUserId": { "type": "integer", "description": "Numeric identifier of the linked Aprimo user account, distinct from this resource's GUID id.", "format": "int32" }, "isActive": { "type": "boolean", "description": "Whether the user is still active or not." }, "modifiedOn": { "type": "string", "description": "Last modification datetime in UTC time.", "format": "date-time" }, "createdOn": { "type": "string", "description": "Creation datetime in UTC time.", "format": "date-time" }, "_links": { "type": "object", "properties": { "fields": { "description": "Relation to a collection of fields.", "$ref": "#/components/schemas/Link" }, "memberships": { "description": "Relation to the collection of all the UserGroups that this user is member of.", "$ref": "#/components/schemas/Link" }, "permissions": { "description": "Relation to the collection of all the Permissions that this user has.", "$ref": "#/components/schemas/Link" }, "image": { "description": "Relation to an image with the picture of the user.", "$ref": "#/components/schemas/Link" }, "modifiedBy": { "description": "Relation to the user who last modified this user.", "$ref": "#/components/schemas/Link" }, "createdBy": { "description": "Relation to the user who created this user.", "$ref": "#/components/schemas/Link" }, "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "fields": { "description": "Relation to a collection of fields. Embed via a \"select-user: fields\" header.", "$ref": "#/components/schemas/FieldCollectionResource" }, "memberships": { "description": "Relation to the collection of all the UserGroups that this user is member of. Embed via a \"select-user: memberships\" header.", "$ref": "#/components/schemas/UserGroupCollectionResource" }, "permissions": { "description": "Relation to the collection of all the Permissions that this user has. Embed via a \"select-user: permissions\" header.", "$ref": "#/components/schemas/PermissionValueCollectionResource" }, "image": { "description": "Relation to an image with the picture of the user. Embed via a \"select-user: image\" header.", "$ref": "#/components/schemas/ImageResource" }, "modifiedBy": { "description": "Relation to the user who last modified this user. Embed via a \"select-user: modifiedBy\" header.", "$ref": "#/components/schemas/UserResource" }, "createdBy": { "description": "Relation to the user who created this user. Embed via a \"select-user: createdBy\" header.", "$ref": "#/components/schemas/UserResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "A DAM user account. Users authenticate to the API, hold permission grants, and are recorded as the creator/modifier of other resources." }, "UsersPermissionModel": { "title": "Users permission model", "type": "object", "properties": { "name": { "type": "string", "description": "The name of the permission." }, "value": { "enum": [ "None", "Granted", "Denied" ], "type": "string", "description": "The role assigned for this permission." }, "id": { "type": "string", "description": "The identifier of this permission, which is its Name." } }, "description": "A single named permission and the role assigned to it." }, "ValidateFieldHtmlCommand": { "title": "Validate field html command", "type": "object", "properties": { "value": { "type": "string", "description": "HTML content to validate." } }, "description": "Validates HTML content in a field value." }, "ValidateFieldHtmlResultNonResource": { "title": "Validate field html result non resource", "type": "object", "properties": { "valid": { "type": "boolean", "description": "Whether the HTML content is valid." }, "parseError": { "type": "string", "description": "Parse error encountered while validating the HTML content, if any." } }, "description": "The result of validating an HTML field value against the allowed tag/attribute list." }, "ValidationErrorResource": { "title": "Validation error resource", "type": "object", "properties": { "type": { "type": "string", "description": "The type of the object containing the ValidationError" }, "senderId": { "type": [ "null", "string" ], "description": "The id or name of the object containing the ValidationError", "format": "uuid" }, "property": { "type": "string", "description": "The Property of the sender the ValidationError is about" }, "error": { "type": "string", "description": "The error message" }, "languageId": { "type": [ "null", "string" ], "description": "The id of the language for which this validation error occurred. Set when the sender is a per-language field value. For single-language fields this is Empty. Null when the error is not tied to a specific field language.", "format": "uuid" } }, "description": "A validation failure on a specific property of an object submitted in a request." }, "ValueFieldModel": { "title": "Value field model", "type": "object", "properties": { "addOrUpdate": { "type": "array", "items": { "type": "string" }, "description": "The values to add or update." }, "remove": { "type": "array", "items": { "type": "string" }, "description": "The values to remove." } }, "description": "Add/remove update for a multi-value field." }, "VersionCollectionResource": { "title": "Version collection resource", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/VersionResource" }, "description": "A collection of resource items." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of a non-paged collection of versions" }, "VersionResource": { "title": "Version resource", "type": "object", "properties": { "version": { "type": "string", "description": "The version number." }, "documentationUri": { "type": "string", "description": "The URI for the documentation." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of a version of the API." }, "VideoPersonThumbnailResource": { "title": "Video person thumbnail resource", "type": "object", "properties": { "faceId": { "type": "integer", "description": "The VI face entry id (persisted \"visualSearch\" blob's faces[].id) this crop belongs to. Not a DAM id - consumers resolve a face's thumbnail by matching this value against the blob's faces[].id. Mirrors FaceId.", "format": "int32" }, "id": { "type": "string", "description": "Identifier for this additional file.", "format": "uuid" }, "type": { "description": "Type of this additional file. On the additional files collection endpoint, the results can be restricted to specific types with a \"select-additionalfile-type\" request header (comma-separated AdditionalFileType names).", "$ref": "#/components/schemas/AdditionalFileType" }, "isManual": { "type": "boolean", "description": "Returns true if this additional has been added manually. false is returned if the additional file was created automatically." }, "label": { "type": "string", "description": "Label of the additional file" }, "fileSize": { "type": "integer", "description": "File size of the additional file", "format": "int64" }, "fileName": { "type": "string", "description": "File name of the additional file" }, "extension": { "type": "string", "description": "File extension of the additional file" }, "tag": { "type": "string", "description": "Tag of the additional file Opt-in: returned only when requested. Include via a \"select-additionalfile: Tag\" header." }, "usages": { "type": "array", "items": { "type": "string" }, "description": "Usages of the additional file. On the additional files collection endpoint, the results can be restricted to specific usages with a \"select-additionalfile-usage\" request header (comma-separated values)." }, "uri": { "type": "string", "description": "Returns a path to image or if no image is assigned. This URL remains valid for four hours. Opt-in: returned only when requested. Include via a \"select-additionalfile: Uri\" header." }, "metadata": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Technical metadata specific to this additional file's type (e.g. video duration, image resolution). The available keys vary by file type and aren't individually documented. Opt-in: returned only when requested. Include via a \"select-additionalfile: Metadata\" header." }, "purposes": { "type": "array", "items": { "type": "string" }, "description": "Purposes of the additional file. On the additional files collection endpoint, the results can be restricted to specific purposes with a \"select-filter-purposes\" request header (comma-separated values)." }, "crc32": { "type": "integer", "description": "CRC32 checksum of this additional file.", "format": "int32" }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" }, "publicLink": { "description": "Relation to the addition file public link.", "$ref": "#/components/schemas/Link" }, "mainPreview": { "description": "Relation to an image of main preview with the size of a preview.", "$ref": "#/components/schemas/Link" }, "filePreviews": { "description": "Relation to a collection of file previews.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "publicLink": { "description": "Relation to the addition file public link. Embed via a \"select-additionalfile: publicLink\" header.", "$ref": "#/components/schemas/PublicLinkResource" }, "mainPreview": { "description": "Relation to an image of main preview with the size of a preview. Embed via a \"select-additionalfile: mainPreview\" header.", "$ref": "#/components/schemas/ImageResource" }, "filePreviews": { "description": "Relation to a collection of file previews. Embed via a \"select-additionalfile: filePreviews\" header.", "$ref": "#/components/schemas/AdditionalFilePreviewCollectionResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "Representation of a face-crop thumbnail: the VI face-detection crop downloaded for one unknown face at video visual-search extraction time." }, "VideoStillCreationMode": { "title": "Video still creation mode", "enum": [ "None", "Sequence", "Single", "Chapter", "SceneDetection" ], "type": "string", "x-enum-descriptions": [ "Meant for internal purposes. Should not be used.", "Allows stills created by sequence (every x seconds).", "Allows for discrete stills.", "Allows stills created for every chapter in the video.", "Allows stills created by detecting scenes in a video." ] }, "VideoSummaryRuleActionModel": { "title": "Video summary rule action model", "type": "object", "properties": { "index": { "type": "integer", "description": "Index of the action within the rule's action collection", "format": "int32" }, "actionType": { "description": "Type of action to be executed.", "$ref": "#/components/schemas/RuleActionDataType" }, "executionTime": { "description": "When the action should be executed.", "$ref": "#/components/schemas/RuleExecutionTime" } }, "description": "Model for VideoSummary rule action" }, "VideoSummaryRuleActionNonResource": { "title": "Video summary rule action non resource", "type": "object", "properties": { "index": { "type": "integer", "description": "Index of a rule action in collection", "format": "int32" }, "actionType": { "description": "Data type of this rule action", "$ref": "#/components/schemas/RuleActionDataType" }, "executionTime": { "description": "Execution time of the rule action", "$ref": "#/components/schemas/RuleExecutionTime" } }, "description": "Representation of Video Summary rule action" }, "WatermarkCreateCommand": { "title": "Watermark create command", "type": "object", "properties": { "name": { "type": "string", "description": "The name of the watermark." }, "position": { "enum": [ "TopLeft", "TopCenter", "TopRight", "MiddleLeft", "MiddleCenter", "MiddleRight", "BottomLeft", "BottomCenter", "BottomRight" ], "type": "string", "description": "The position where the watermark is placed on the asset." }, "tag": { "type": "string", "description": "A custom tag associated with the watermark." }, "image": { "type": "string", "description": "The watermark image." } }, "description": "Command to create a watermark." }, "WatermarkEditCommand": { "title": "Watermark edit command", "type": "object", "properties": { "name": { "type": "string", "description": "The name of the watermark." }, "position": { "enum": [ "TopLeft", "TopCenter", "TopRight", "MiddleLeft", "MiddleCenter", "MiddleRight", "BottomLeft", "BottomCenter", "BottomRight" ], "type": "string", "description": "The position where the watermark is placed on the asset." }, "tag": { "type": "string", "description": "A custom tag associated with the watermark." }, "image": { "type": "string", "description": "The watermark image." } }, "description": "Command to edit a watermark." }, "WatermarkPagedCollectionResource": { "title": "Watermark paged collection resource", "type": "object", "properties": { "pageNumber": { "type": [ "null", "integer" ], "description": "The current page of this paged collection.", "format": "int32" }, "pageSize": { "type": [ "null", "integer" ], "description": "The current page size of this paged collection.", "format": "int32" }, "skip": { "type": [ "null", "integer" ], "description": "The current skip size of this paged collection.", "format": "int32" }, "take": { "type": [ "null", "integer" ], "description": "The current take size of this paged collection.", "format": "int32" }, "totalCount": { "type": "integer", "description": "The total count of items in this paged collection, not just on the current page.", "format": "int64" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/WatermarkResource" }, "description": "One page of this paged collection, which is a subcollection of the complete collection." }, "_links": { "type": "object", "properties": { "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" }, "first": { "description": "A link to the first page of this paged collection.", "$ref": "#/components/schemas/Link" }, "prev": { "description": "A link to the previous page of this paged collection.", "$ref": "#/components/schemas/Link" }, "next": { "description": "A link to the next page of this paged collection.", "$ref": "#/components/schemas/Link" }, "last": { "description": "A link to the last page of this paged collection.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." } }, "description": "Representation of a paged collection of watermarks" }, "WatermarkPosition": { "title": "Watermark position", "enum": [ "TopLeft", "TopCenter", "TopRight", "MiddleLeft", "MiddleCenter", "MiddleRight", "BottomLeft", "BottomCenter", "BottomRight" ], "type": "string", "x-enum-descriptions": [ "The watermark is positioned in the top-left corner.", "The watermark is positioned at the top, horizontally centered.", "The watermark is positioned in the top-right corner.", "The watermark is positioned on the left, vertically centered.", "The watermark is positioned in the center of the image.", "The watermark is positioned on the right, vertically centered.", "The watermark is positioned in the bottom-left corner.", "The watermark is positioned at the bottom, horizontally centered.", "The watermark is positioned in the bottom-right corner." ] }, "WatermarkResource": { "title": "Watermark resource", "type": "object", "properties": { "id": { "type": "string", "description": "Id of this watermark.", "format": "uuid" }, "name": { "type": "string", "description": "Name of this watermark." }, "position": { "description": "Watermark position.", "$ref": "#/components/schemas/WatermarkPosition" }, "tag": { "type": "string", "description": "Value for the Tag of this object. The value of this property should be valid Xml. Opt-in: returned only when requested. Include via a \"select-watermark: Tag\" header." }, "modifiedOn": { "type": "string", "description": "Last modification datetime in UTC time.", "format": "date-time" }, "createdOn": { "type": "string", "description": "Creation datetime in UTC time.", "format": "date-time" }, "_links": { "type": "object", "properties": { "image": { "description": "Relation to the image of the watermark.", "$ref": "#/components/schemas/Link" }, "modifiedBy": { "description": "Relation to the user who last modified this watermark.", "$ref": "#/components/schemas/Link" }, "createdBy": { "description": "Relation to the user who created this watermark.", "$ref": "#/components/schemas/Link" }, "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "image": { "description": "Relation to the image of the watermark. Embed via a \"select-watermark: image\" header.", "$ref": "#/components/schemas/ImageResource" }, "modifiedBy": { "description": "Relation to the user who last modified this watermark. Embed via a \"select-watermark: modifiedBy\" header.", "$ref": "#/components/schemas/UserResource" }, "createdBy": { "description": "Relation to the user who created this watermark. Embed via a \"select-watermark: createdBy\" header.", "$ref": "#/components/schemas/UserResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "A transparent overlay image (e.g. a logo or copyright mark) that can be applied on top of another image via a rule action or a resize/watermark operation." }, "XmlSettingDefinitionCreateCommand": { "title": "Xml setting definition create command", "type": "object", "properties": { "defaultValue": { "type": "string", "description": "Default value for this XML setting definition." }, "schema": { "type": "string", "description": "XML schema used to validate the value of this setting definition." }, "dataType": { "description": "Data type of the setting definition to create. Determines which additional properties apply.", "$ref": "#/components/schemas/SettingDefinitionType" }, "name": { "type": "string", "description": "Name of this setting definition." }, "categoryId": { "type": "string", "description": "Id of the setting category this setting definition belongs to.", "format": "uuid" }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelModel" }, "description": "Multi-language labels for the name of this setting definition." }, "allowSystemSetting": { "type": "boolean", "description": "When set, allows this setting to be configured at the system level." }, "allowUserSetting": { "type": "boolean", "description": "When set, allows this setting to be configured at the user level." }, "roleRequiredForChange": { "type": "string", "description": "Name of the role required to change settings of this definition." }, "userGroupSettingMode": { "enum": [ "None", "MaximumValue", "MinimumValue", "Manual", "FirstValue" ], "type": "string", "description": "Algorithm used to calculate the effective value for user group settings of this definition." }, "helpUrl": { "type": "string", "description": "URL to help documentation for this setting definition." }, "tag": { "type": "string", "description": "Free-form tag for this setting definition." } }, "description": "Creates a new XML setting definition." }, "XmlSettingDefinitionResource": { "title": "Xml setting definition resource", "type": "object", "properties": { "defaultValue": { "type": "string", "description": "Default value of the setting" }, "schema": { "type": "string", "description": "Scheme that the field value should match" }, "id": { "type": "string", "description": "Id of the setting definition", "format": "uuid" }, "helpUrl": { "type": "string", "description": "Help url for the setting definition" }, "userGroupSettingMode": { "enum": [ "None", "MaximumValue", "MinimumValue", "Manual", "FirstValue" ], "type": "string", "description": "UserGroupSettingMode for the setting definition" }, "categoryId": { "type": "string", "description": "Category Id for the setting definition", "format": "uuid" }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/LabelNonResource" }, "description": "Collection of labels for the setting definition" }, "allowSystemSetting": { "type": "boolean", "description": "Indicates whether this setting can be configured at the system level." }, "allowUserSetting": { "type": "boolean", "description": "Indicates whether this setting can be configured per user." }, "roleRequiredForChange": { "type": "string", "description": "Role that needs to be changed" }, "name": { "type": "string", "description": "Name of the setting definition" }, "dataType": { "enum": [ "None", "Boolean", "Text", "Numeric", "DateTime", "Xml", "Role", "Reference", "EncryptedText", "DefSchema" ], "type": "string", "description": "Data type of this setting" }, "tag": { "type": "string", "description": "Tag for this setting containing extra information. Opt-in: returned only when requested. Include via a \"select-settingdefinition: Tag\" header." }, "modifiedOn": { "type": "string", "description": "Last modification datetime in UTC time.", "format": "date-time" }, "createdOn": { "type": "string", "description": "Creation datetime in UTC time.", "format": "date-time" }, "_links": { "type": "object", "properties": { "modifiedBy": { "description": "Relation to the user who last modified this settingdefinition.", "$ref": "#/components/schemas/Link" }, "createdBy": { "description": "Relation to the user who created this settingdefinition.", "$ref": "#/components/schemas/Link" }, "self": { "description": "Provides a link to this resource.", "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "_embedded": { "type": "object", "properties": { "modifiedBy": { "description": "Relation to the user who last modified this settingdefinition. Embed via a \"select-xmlsettingdefinition: modifiedBy\" header.", "$ref": "#/components/schemas/UserResource" }, "createdBy": { "description": "Relation to the user who created this settingdefinition. Embed via a \"select-xmlsettingdefinition: createdBy\" header.", "$ref": "#/components/schemas/UserResource" } }, "description": "Hypermedia-embedded (HAL-style) related resources, inlined here when requested/expanded." } }, "description": "Representation of a XmlSettingDefinition resource." } }, "mediaTypes": { "IPagedCollectionResourceOfAccessListResourceHal": { "schema": { "required": [ "_links" ], "type": "object", "properties": { "_links": { "type": "object", "properties": { "self": { "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/AccessListResource" } }, "page": { "type": [ "null", "integer" ] }, "pageSize": { "type": [ "null", "integer" ] }, "totalCount": { "type": "integer", "format": "int64" } }, "description": "A paged/collection response envelope." } }, "IPagedCollectionResourceOfAccessListResourceJson": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/AccessListResource" } }, "page": { "type": [ "null", "integer" ] }, "pageSize": { "type": [ "null", "integer" ] }, "totalCount": { "type": "integer", "format": "int64" } }, "description": "A paged/collection response envelope." } }, "AdditionalFilePreviewCollectionResourceHal": { "schema": { "required": [ "_links" ], "$ref": "#/components/schemas/AdditionalFilePreviewCollectionResource" } }, "AdditionalFilePreviewCollectionResourceJson": { "schema": { "title": "Additional file preview collection resource", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/AdditionalFilePreviewResource" }, "description": "A collection of resource items." } }, "description": "Representation of a non-paged collection of additional file previews" } }, "IPagedCollectionResourceOfAnnotationResourceHal": { "schema": { "required": [ "_links" ], "type": "object", "properties": { "_links": { "type": "object", "properties": { "self": { "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/AnnotationResource" } }, "page": { "type": [ "null", "integer" ] }, "pageSize": { "type": [ "null", "integer" ] }, "totalCount": { "type": "integer", "format": "int64" } }, "description": "A paged/collection response envelope." } }, "IPagedCollectionResourceOfAnnotationResourceJson": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/AnnotationResource" } }, "page": { "type": [ "null", "integer" ] }, "pageSize": { "type": [ "null", "integer" ] }, "totalCount": { "type": "integer", "format": "int64" } }, "description": "A paged/collection response envelope." } }, "LinkedClassificationCollectionResourceHal": { "schema": { "required": [ "_links" ], "$ref": "#/components/schemas/LinkedClassificationCollectionResource" } }, "LinkedClassificationCollectionResourceJson": { "schema": { "title": "Linked classification collection resource", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/LinkedClassificationResource" }, "description": "A collection of resource items." } }, "description": "Representation of a non-paged collection of linked classifications" } }, "ClassificationCollectionResourceHal": { "schema": { "required": [ "_links" ], "$ref": "#/components/schemas/ClassificationCollectionResource" } }, "ClassificationCollectionResourceJson": { "schema": { "title": "Classification collection resource", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ClassificationResource" }, "description": "A collection of resource items." } }, "description": "Representation of a non-paged collection of classifications" } }, "FieldCollectionResourceHal": { "schema": { "required": [ "_links" ], "$ref": "#/components/schemas/FieldCollectionResource" } }, "FieldCollectionResourceJson": { "schema": { "title": "Field collection resource", "type": "object", "properties": { "items": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/SingleLineTextFieldResource" }, { "$ref": "#/components/schemas/MultiLineTextFieldResource" }, { "$ref": "#/components/schemas/NumericFieldResource" }, { "$ref": "#/components/schemas/DateTimeFieldResource" }, { "$ref": "#/components/schemas/DateFieldResource" }, { "$ref": "#/components/schemas/TimeFieldResource" }, { "$ref": "#/components/schemas/OptionListFieldResource" }, { "$ref": "#/components/schemas/DurationFieldResource" }, { "$ref": "#/components/schemas/UserListFieldResource" }, { "$ref": "#/components/schemas/UserGroupListFieldResource" }, { "$ref": "#/components/schemas/HtmlFieldResource" }, { "$ref": "#/components/schemas/JsonFieldResource" }, { "$ref": "#/components/schemas/ClassificationListFieldResource" }, { "$ref": "#/components/schemas/RecordListFieldResource" }, { "$ref": "#/components/schemas/RecordLinkFieldResource" }, { "$ref": "#/components/schemas/LanguageListFieldResource" }, { "$ref": "#/components/schemas/TextListFieldResource" }, { "$ref": "#/components/schemas/HyperlinkListFieldResource" } ], "discriminator": { "propertyName": "dataType", "mapping": { "SingleLineText": "#/components/schemas/SingleLineTextFieldResource", "MultiLineText": "#/components/schemas/MultiLineTextFieldResource", "Numeric": "#/components/schemas/NumericFieldResource", "DateTime": "#/components/schemas/DateTimeFieldResource", "Date": "#/components/schemas/DateFieldResource", "Time": "#/components/schemas/TimeFieldResource", "OptionList": "#/components/schemas/OptionListFieldResource", "Duration": "#/components/schemas/DurationFieldResource", "UserList": "#/components/schemas/UserListFieldResource", "UserGroupList": "#/components/schemas/UserGroupListFieldResource", "Html": "#/components/schemas/HtmlFieldResource", "Json": "#/components/schemas/JsonFieldResource", "ClassificationList": "#/components/schemas/ClassificationListFieldResource", "RecordList": "#/components/schemas/RecordListFieldResource", "RecordLink": "#/components/schemas/RecordLinkFieldResource", "LanguageList": "#/components/schemas/LanguageListFieldResource", "TextList": "#/components/schemas/TextListFieldResource", "HyperlinkList": "#/components/schemas/HyperlinkListFieldResource" } } }, "description": "A collection of resource items." } }, "description": "Representation of a non-paged collection of fields" } }, "IPagedCollectionResourceOfCommentResourceHal": { "schema": { "required": [ "_links" ], "type": "object", "properties": { "_links": { "type": "object", "properties": { "self": { "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/CommentResource" } }, "page": { "type": [ "null", "integer" ] }, "pageSize": { "type": [ "null", "integer" ] }, "totalCount": { "type": "integer", "format": "int64" } }, "description": "A paged/collection response envelope." } }, "IPagedCollectionResourceOfCommentResourceJson": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CommentResource" } }, "page": { "type": [ "null", "integer" ] }, "pageSize": { "type": [ "null", "integer" ] }, "totalCount": { "type": "integer", "format": "int64" } }, "description": "A paged/collection response envelope." } }, "DownloadAgreementClassificationCollectionResourceHal": { "schema": { "required": [ "_links" ], "$ref": "#/components/schemas/DownloadAgreementClassificationCollectionResource" } }, "DownloadAgreementClassificationCollectionResourceJson": { "schema": { "title": "Download agreement classification collection resource", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/DownloadAgreementClassificationResource" }, "description": "A collection of resource items." } }, "description": "Representation of a non-paged collection of download agreement classifications" } }, "DownloadAgreementContentCollectionResourceHal": { "schema": { "required": [ "_links" ], "$ref": "#/components/schemas/DownloadAgreementContentCollectionResource" } }, "DownloadAgreementContentCollectionResourceJson": { "schema": { "title": "Download agreement content collection resource", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/DownloadAgreementContentResource" }, "description": "A collection of non-resource items." } }, "description": "Representation of a collection of download agreement's content" } }, "DownloadAgreementUserGroupCollectionResourceHal": { "schema": { "required": [ "_links" ], "$ref": "#/components/schemas/DownloadAgreementUserGroupCollectionResource" } }, "DownloadAgreementUserGroupCollectionResourceJson": { "schema": { "title": "Download agreement user group collection resource", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/DownloadAgreementUserGroupResource" }, "description": "A collection of resource items." } }, "description": "Collection of applicable download agreement's user groups" } }, "DownloadLinkTargetCollectionResourceHal": { "schema": { "required": [ "_links" ], "$ref": "#/components/schemas/DownloadLinkTargetCollectionResource" } }, "DownloadLinkTargetCollectionResourceJson": { "schema": { "title": "Download link target collection resource", "type": "object", "properties": { "items": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/ExportAuditDownloadLinkTargetResource" }, { "$ref": "#/components/schemas/ExportMetadataDownloadLinkTargetResource" }, { "$ref": "#/components/schemas/OrderDownloadLinkTargetResource" }, { "$ref": "#/components/schemas/OrderDownloadLinkMassTargetResource" } ] }, "description": "A collection of resource items." } }, "description": "A collection of download link targets." } }, "IPagedCollectionOfClassificationListFieldItemResourceHal": { "schema": { "required": [ "_links" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ClassificationListFieldItemResource" } }, "page": { "type": [ "null", "integer" ] }, "pageSize": { "type": [ "null", "integer" ] }, "totalCount": { "type": "integer", "format": "int64" } }, "description": "A paged/collection response envelope." } }, "IPagedCollectionOfClassificationListFieldItemResourceJson": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ClassificationListFieldItemResource" } }, "page": { "type": [ "null", "integer" ] }, "pageSize": { "type": [ "null", "integer" ] }, "totalCount": { "type": "integer", "format": "int64" } }, "description": "A paged/collection response envelope." } }, "FieldDefinitionCollectionResourceHal": { "schema": { "required": [ "_links" ], "$ref": "#/components/schemas/FieldDefinitionCollectionResource" } }, "FieldDefinitionCollectionResourceJson": { "schema": { "title": "Field definition collection resource", "type": "object", "properties": { "items": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/HtmlFieldDefinitionResource" }, { "$ref": "#/components/schemas/MultiLineTextFieldDefinitionResource" }, { "$ref": "#/components/schemas/SingleLineTextFieldDefinitionResource" }, { "$ref": "#/components/schemas/JsonFieldDefinitionResource" }, { "$ref": "#/components/schemas/NumericFieldDefinitionResource" }, { "$ref": "#/components/schemas/ClassificationListFieldDefinitionResource" }, { "$ref": "#/components/schemas/DateFieldDefinitionResource" }, { "$ref": "#/components/schemas/DateTimeFieldDefinitionResource" }, { "$ref": "#/components/schemas/DurationFieldDefinitionResource" }, { "$ref": "#/components/schemas/OptionListFieldDefinitionResource" }, { "$ref": "#/components/schemas/RecordLinkFieldDefinitionResource" }, { "$ref": "#/components/schemas/RecordListFieldDefinitionResource" }, { "$ref": "#/components/schemas/TimeFieldDefinitionResource" }, { "$ref": "#/components/schemas/UserListFieldDefinitionResource" }, { "$ref": "#/components/schemas/UserGroupListFieldDefinitionResource" }, { "$ref": "#/components/schemas/LanguageListFieldDefinitionResource" }, { "$ref": "#/components/schemas/TextListFieldDefinitionResource" }, { "$ref": "#/components/schemas/HyperlinkListFieldDefinitionResource" } ] }, "description": "A collection of resource items." } }, "description": "Representation of a collection of field definitions" } }, "IPagedCollectionResourceOfFieldPopulationLogSummaryResourceHal": { "schema": { "required": [ "_links" ], "type": "object", "properties": { "_links": { "type": "object", "properties": { "self": { "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/FieldPopulationLogSummaryResource" } }, "page": { "type": [ "null", "integer" ] }, "pageSize": { "type": [ "null", "integer" ] }, "totalCount": { "type": "integer", "format": "int64" } }, "description": "A paged/collection response envelope." } }, "IPagedCollectionResourceOfFieldPopulationLogSummaryResourceJson": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/FieldPopulationLogSummaryResource" } }, "page": { "type": [ "null", "integer" ] }, "pageSize": { "type": [ "null", "integer" ] }, "totalCount": { "type": "integer", "format": "int64" } }, "description": "A paged/collection response envelope." } }, "IPagedCollectionResourceOfFieldPopulationLogPredictionResourceHal": { "schema": { "required": [ "_links" ], "type": "object", "properties": { "_links": { "type": "object", "properties": { "self": { "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/FieldPopulationLogPredictionResource" } }, "page": { "type": [ "null", "integer" ] }, "pageSize": { "type": [ "null", "integer" ] }, "totalCount": { "type": "integer", "format": "int64" } }, "description": "A paged/collection response envelope." } }, "IPagedCollectionResourceOfFieldPopulationLogPredictionResourceJson": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/FieldPopulationLogPredictionResource" } }, "page": { "type": [ "null", "integer" ] }, "pageSize": { "type": [ "null", "integer" ] }, "totalCount": { "type": "integer", "format": "int64" } }, "description": "A paged/collection response envelope." } }, "IPagedCollectionResourceOfFileProcessActionResourceHal": { "schema": { "required": [ "_links" ], "type": "object", "properties": { "_links": { "type": "object", "properties": { "self": { "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/FileProcessActionResource" } }, "page": { "type": [ "null", "integer" ] }, "pageSize": { "type": [ "null", "integer" ] }, "totalCount": { "type": "integer", "format": "int64" } }, "description": "A paged/collection response envelope." } }, "IPagedCollectionResourceOfFileProcessActionResourceJson": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/FileProcessActionResource" } }, "page": { "type": [ "null", "integer" ] }, "pageSize": { "type": [ "null", "integer" ] }, "totalCount": { "type": "integer", "format": "int64" } }, "description": "A paged/collection response envelope." } }, "ICollectionResourceOfFilePreviewResourceHal": { "schema": { "required": [ "_links" ], "type": "object", "properties": { "_links": { "type": "object", "properties": { "self": { "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/FilePreviewResource" } } }, "description": "A paged/collection response envelope." } }, "ICollectionResourceOfFilePreviewResourceJson": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/FilePreviewResource" } } }, "description": "A paged/collection response envelope." } }, "ICollectionResourceOfFileProcessActionLogResourceHal": { "schema": { "required": [ "_links" ], "type": "object", "properties": { "_links": { "type": "object", "properties": { "self": { "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/FileProcessActionLogResource" } } }, "description": "A paged/collection response envelope." } }, "ICollectionResourceOfFileProcessActionLogResourceJson": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/FileProcessActionLogResource" } } }, "description": "A paged/collection response envelope." } }, "PublicLinkCollectionResourceHal": { "schema": { "required": [ "_links" ], "$ref": "#/components/schemas/PublicLinkCollectionResource" } }, "PublicLinkCollectionResourceJson": { "schema": { "title": "Public link collection resource", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PublicLinkResource" }, "description": "A collection of resource items." } }, "description": "Representation of a non-paged collection of public links" } }, "RenditionCollectionResourceHal": { "schema": { "required": [ "_links" ], "$ref": "#/components/schemas/RenditionCollectionResource" } }, "RenditionCollectionResourceJson": { "schema": { "title": "Rendition collection resource", "type": "object", "properties": { "items": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/OriginalRenditionResource" }, { "$ref": "#/components/schemas/PresetRenditionResource" }, { "$ref": "#/components/schemas/TrimRenditionResource" }, { "$ref": "#/components/schemas/CropRenditionResource" }, { "$ref": "#/components/schemas/CustomRenditionResource" } ] }, "description": "A collection of resource items." } }, "description": "Representation of a non-paged collection of renditions" } }, "IPagedCollectionResourceOfNonResourcesOfLinkedVersionInfoNonResourceHal": { "schema": { "required": [ "_links" ], "type": "object", "properties": { "_links": { "type": "object", "properties": { "self": { "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/LinkedVersionInfoNonResource" } }, "page": { "type": [ "null", "integer" ] }, "pageSize": { "type": [ "null", "integer" ] }, "totalCount": { "type": "integer", "format": "int64" } }, "description": "A paged/collection response envelope." } }, "IPagedCollectionResourceOfNonResourcesOfLinkedVersionInfoNonResourceJson": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/LinkedVersionInfoNonResource" } }, "page": { "type": [ "null", "integer" ] }, "pageSize": { "type": [ "null", "integer" ] }, "totalCount": { "type": "integer", "format": "int64" } }, "description": "A paged/collection response envelope." } }, "IPagedCollectionResourceOfImageOverlayResourceHal": { "schema": { "required": [ "_links" ], "type": "object", "properties": { "_links": { "type": "object", "properties": { "self": { "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ImageOverlayResource" } }, "page": { "type": [ "null", "integer" ] }, "pageSize": { "type": [ "null", "integer" ] }, "totalCount": { "type": "integer", "format": "int64" } }, "description": "A paged/collection response envelope." } }, "IPagedCollectionResourceOfImageOverlayResourceJson": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ImageOverlayResource" } }, "page": { "type": [ "null", "integer" ] }, "pageSize": { "type": [ "null", "integer" ] }, "totalCount": { "type": "integer", "format": "int64" } }, "description": "A paged/collection response envelope." } }, "ImageOverlayClassificationCollectionResourceHal": { "schema": { "required": [ "_links" ], "$ref": "#/components/schemas/ImageOverlayClassificationCollectionResource" } }, "ImageOverlayClassificationCollectionResourceJson": { "schema": { "title": "Image overlay classification collection resource", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ImageOverlayClassificationResource" }, "description": "A collection of resource items." } }, "description": "Representation of a non-paged collection of image overlay classifications" } }, "ImageOverlayUserGroupCollectionResourceHal": { "schema": { "required": [ "_links" ], "$ref": "#/components/schemas/ImageOverlayUserGroupCollectionResource" } }, "ImageOverlayUserGroupCollectionResourceJson": { "schema": { "title": "Image overlay user group collection resource", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ImageOverlayUserGroupResource" }, "description": "A collection of resource items." } }, "description": "Collection of applicable Image overlay's user groups" } }, "MaintenanceTargetCollectionResourceHal": { "schema": { "required": [ "_links" ], "$ref": "#/components/schemas/MaintenanceTargetCollectionResource" } }, "MaintenanceTargetCollectionResourceJson": { "schema": { "title": "Maintenance target collection resource", "type": "object", "properties": { "items": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/RecordMaintenanceTargetResource" }, { "$ref": "#/components/schemas/ClassificationMaintenanceTargetResource" }, { "$ref": "#/components/schemas/RuleMaintenanceTargetResource" }, { "$ref": "#/components/schemas/ReportingMaintenanceTargetResource" }, { "$ref": "#/components/schemas/OrderTargetResource" } ] }, "description": "A collection of resource items." } }, "description": "A collection of maintenance targets." } }, "OrderPagedCollectionResourceHal": { "schema": { "required": [ "_links" ], "$ref": "#/components/schemas/OrderPagedCollectionResource" } }, "OrderPagedCollectionResourceJson": { "schema": { "title": "Order paged collection resource", "type": "object", "properties": { "pageNumber": { "type": [ "null", "integer" ], "description": "The current page of this paged collection.", "format": "int32" }, "pageSize": { "type": [ "null", "integer" ], "description": "The current page size of this paged collection.", "format": "int32" }, "skip": { "type": [ "null", "integer" ], "description": "The current skip size of this paged collection.", "format": "int32" }, "take": { "type": [ "null", "integer" ], "description": "The current take size of this paged collection.", "format": "int32" }, "totalCount": { "type": "integer", "description": "The total count of items in this paged collection, not just on the current page.", "format": "int64" }, "items": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/AkamaiCdnOrderResource" }, { "$ref": "#/components/schemas/BrandTemplateOrderResource" }, { "$ref": "#/components/schemas/BrandTemplatePreprocessingOrderResource" }, { "$ref": "#/components/schemas/DownloadOrderResource" }, { "$ref": "#/components/schemas/EmailOrderResource" }, { "$ref": "#/components/schemas/FtpOrderResource" }, { "$ref": "#/components/schemas/FtpResortOrderResource" }, { "$ref": "#/components/schemas/PublicCdnOrderResource" }, { "$ref": "#/components/schemas/ShareDownloadLinkOrderResource" }, { "$ref": "#/components/schemas/DownloadContactSheetResource" } ], "discriminator": { "propertyName": "orderType", "mapping": { "akamaiCdn": "#/components/schemas/AkamaiCdnOrderResource", "brandTemplate": "#/components/schemas/BrandTemplateOrderResource", "brandTemplatePreprocessing": "#/components/schemas/BrandTemplatePreprocessingOrderResource", "download": "#/components/schemas/DownloadOrderResource", "email": "#/components/schemas/EmailOrderResource", "ftp": "#/components/schemas/FtpOrderResource", "ftpResort": "#/components/schemas/FtpResortOrderResource", "publicCdn": "#/components/schemas/PublicCdnOrderResource", "shareDownloadLink": "#/components/schemas/ShareDownloadLinkOrderResource", "contactsheet": "#/components/schemas/DownloadContactSheetResource" } } }, "description": "One page of this paged collection, which is a subcollection of the complete collection." } }, "description": "Representation of a paged collection of orders" } }, "OrderTargetCollectionResourceHal": { "schema": { "required": [ "_links" ], "$ref": "#/components/schemas/OrderTargetCollectionResource" } }, "OrderTargetCollectionResourceJson": { "schema": { "title": "Order target collection resource", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/OrderTargetResource" }, "description": "A collection of resource items." } }, "description": "A collection of order targets" } }, "IPagedCollectionResourceOfCollectionResourceHal": { "schema": { "required": [ "_links" ], "type": "object", "properties": { "_links": { "type": "object", "properties": { "self": { "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/CollectionResource" } }, "page": { "type": [ "null", "integer" ] }, "pageSize": { "type": [ "null", "integer" ] }, "totalCount": { "type": "integer", "format": "int64" } }, "description": "A paged/collection response envelope." } }, "IPagedCollectionResourceOfCollectionResourceJson": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CollectionResource" } }, "page": { "type": [ "null", "integer" ] }, "pageSize": { "type": [ "null", "integer" ] }, "totalCount": { "type": "integer", "format": "int64" } }, "description": "A paged/collection response envelope." } }, "RecordClassificationCollectionResourceHal": { "schema": { "required": [ "_links" ], "$ref": "#/components/schemas/RecordClassificationCollectionResource" } }, "RecordClassificationCollectionResourceJson": { "schema": { "title": "Record classification collection resource", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/RecordClassificationResource" }, "description": "A collection of resource items." } }, "description": "Representation of a non-paged collection of record classifications" } }, "FileCollectionResourceHal": { "schema": { "required": [ "_links" ], "$ref": "#/components/schemas/FileCollectionResource" } }, "FileCollectionResourceJson": { "schema": { "title": "File collection resource", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/FileResource" }, "description": "A collection of resource items." } }, "description": "Representation of a non-paged collection of files" } }, "VersionCollectionResourceHal": { "schema": { "required": [ "_links" ], "$ref": "#/components/schemas/VersionCollectionResource" } }, "VersionCollectionResourceJson": { "schema": { "title": "Version collection resource", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/VersionResource" }, "description": "A collection of resource items." } }, "description": "Representation of a non-paged collection of versions" } }, "UserPagedCollectionResourceHal": { "schema": { "required": [ "_links" ], "$ref": "#/components/schemas/UserPagedCollectionResource" } }, "UserPagedCollectionResourceJson": { "schema": { "title": "User paged collection resource", "type": "object", "properties": { "pageNumber": { "type": [ "null", "integer" ], "description": "The current page of this paged collection.", "format": "int32" }, "pageSize": { "type": [ "null", "integer" ], "description": "The current page size of this paged collection.", "format": "int32" }, "skip": { "type": [ "null", "integer" ], "description": "The current skip size of this paged collection.", "format": "int32" }, "take": { "type": [ "null", "integer" ], "description": "The current take size of this paged collection.", "format": "int32" }, "totalCount": { "type": "integer", "description": "The total count of items in this paged collection, not just on the current page.", "format": "int64" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/UserResource" }, "description": "One page of this paged collection, which is a subcollection of the complete collection." } }, "description": "Representation of a paged collection of users" } }, "PermissionValueCollectionResourceHal": { "schema": { "required": [ "_links" ], "$ref": "#/components/schemas/PermissionValueCollectionResource" } }, "PermissionValueCollectionResourceJson": { "schema": { "title": "Permission value collection resource", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PermissionValueResource" }, "description": "A collection of resource items." } }, "description": "Representation of a non-paged collection of permission values" } }, "IPagedCollectionResourceOfUserGroupResourceHal": { "schema": { "required": [ "_links" ], "type": "object", "properties": { "_links": { "type": "object", "properties": { "self": { "$ref": "#/components/schemas/Link" } }, "description": "Hypermedia links (HAL-style) to related resources." }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroupResource" } }, "page": { "type": [ "null", "integer" ] }, "pageSize": { "type": [ "null", "integer" ] }, "totalCount": { "type": "integer", "format": "int64" } }, "description": "A paged/collection response envelope." } }, "IPagedCollectionResourceOfUserGroupResourceJson": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroupResource" } }, "page": { "type": [ "null", "integer" ] }, "pageSize": { "type": [ "null", "integer" ] }, "totalCount": { "type": "integer", "format": "int64" } }, "description": "A paged/collection response envelope." } } } }, "tags": [ { "name": "Access list", "description": "A reusable, named set of users and user groups with permission grants (record, classification, download, etc.) that can be assigned to classifications or records in bulk, instead of granting each permission individually." }, { "name": "Action type", "description": "The kind of automated check a check performs against a file version (e.g. a virus scan or an image validation) - every check is configured with one action type." }, { "name": "Additional file", "description": "An extra file stored alongside a file version's primary content - e.g. the original source file it was converted from, or a sidecar file - kept for reference rather than served as the record's main rendition." }, { "name": "Annotation", "description": "A plain-text comment and/or XFDF markup attached to a specific page of a file version, optionally threaded as a reply to another annotation - used for collaborative review of documents." }, { "name": "Calculated permission", "description": "The effective permission level for a user on a resource, resolved when the user's direct permission and their user group's permission would otherwise conflict - DAM computes the winning value so a client doesn't have to reconcile the conflicting grants itself." }, { "name": "Check", "description": "A labeled, repeatable check definition (e.g. \"Brand Color Check\") that lets an external system run automated review checks (tone, brand color, logo, sizing, etc.) outside of Aprimo and write the results back so they surface to users in the platform. Checks are typically triggered by a DAM rule or a PM workflow status action webhook, which notifies the external system to fetch the content, run the check, and post the result back via this API. Create one, cache its Id, and reuse it every time that check runs." }, { "name": "Check category", "description": "A named grouping used to organize check definitions for display and filtering. Stock, non-customizable categories: Risk & Compliance, Brand Consistency, Message Clarity, Channel Readiness." }, { "name": "Classification", "description": "A node in the hierarchical taxonomy used to categorize records. Records are classified by linking them to one or more classifications; field definitions, permissions, and download restrictions can be attached at any node and are inherited by its descendants." }, { "name": "Collection", "description": "A user-curated, named group of records that can be shared, commented on, and populated either by explicitly adding records or by saved search criteria - independent of the classification tree." }, { "name": "Content type", "description": "Defines which fields, classifications, and rules apply to a record based on what kind of record it is (e.g. \"Image\", \"Video\", \"Document\"). Every record has exactly one content type." }, { "name": "Counter", "description": "A named, persistent, atomically-incrementing integer sequence, typically used to generate a unique, ever-increasing value (e.g. an invoice number or SKU) for a custom field." }, { "name": "CSP policy", "description": "The Content Security Policy domain allowlist enforced for this DAM instance." }, { "name": "Download", "description": "Secure, token-based download of a file's binary content." }, { "name": "Download agreement", "description": "A policy that users must accept before they can download content." }, { "name": "Download agreement content", "description": "The localized title and terms-of-use text for a download agreement, versioned per language - the actual text a user reads and accepts." }, { "name": "Download link", "description": "The result of a maintenance job that generates downloadable files (e.g. a download order, export, or contact sheet), including its status, generated files, and any download agreements that apply." }, { "name": "Field definition", "description": "Defines a custom metadata field (name, data type, validation rules) that can be attached to classifications or content types and then populated with a value on each record." }, { "name": "Field group", "description": "A named grouping of field definitions, used to organize related fields together for display in the DAM UI." }, { "name": "Field population log", "description": "Machine-learning field-value predictions made during record processing, and aggregate stats on how often each field's predictions were retained (accepted) versus overwritten." }, { "name": "File", "description": "A binary file attached to a record (e.g. the actual image, video, or document). A record can have multiple files, and each file keeps its own version history as file versions." }, { "name": "File preview", "description": "A single rendered preview image and its thumbnail for a specific file version; multi-page documents have one per page." }, { "name": "File process action", "description": "A configurable processing step that runs at a specific stage of a file's processing pipeline, in a fixed sort order, and can be individually enabled or disabled." }, { "name": "File type", "description": "A configured file type (e.g. JPEG, PDF) defining how files of that kind are processed - media engines, previews, catalog actions, and supported operations such as resizing or watermarking." }, { "name": "File version", "description": "A specific saved revision of a file's content - replacing or re-uploading a file creates a new version while preserving earlier ones for history. New versions are created by submitting a files.addOrUpdate[].versions.addOrUpdate[] entry on POST /record or PUT /record/:id; there is no standalone create endpoint under file version itself." }, { "name": "Home", "description": "The API root - provides links to every top-level resource collection (records, classifications, content types, field definitions, users, settings, and more) so a client can discover the whole API by following links from here." }, { "name": "Image overlay", "description": "A configurable graphic that a rule action can apply on top of an image rendition - e.g. to visually flag its status - shown only to the user groups it's scoped to." }, { "name": "Info", "description": "Version information about the currently active DAM release." }, { "name": "Language", "description": "A language enabled in this tenant that multi-language fields and labels can store localized values in." }, { "name": "Maintenance job", "description": "An asynchronous background job that applies one or more maintenance actions (e.g. reprocessing or reindexing) to a set of target records or files, tracked through to completion with status, timing, and per-target results." }, { "name": "Order", "description": "A request to have DAM assemble and deliver files (e.g. a set of resized or converted assets) for download. Since the order is internally executed as a maintenance job, some properties might reference the term \"job\" instead of the order." }, { "name": "Permission", "description": "A right that can be granted to a user or user group (e.g. read, write, delete) on a record, classification, or collection - this resource is the catalog entry describing the right itself, not a specific grant of it." }, { "name": "Public link", "description": "A shareable, tokenized URL that grants unauthenticated access to a specific file version's content, letting a record's assets be shared with people outside the DAM tenant." }, { "name": "Record", "description": "The core content entity in DAM - a piece of digital content (e.g. an image, video, or document) together with its metadata fields, classifications, and attached files. Includes an action to download the binary image data of the record's master file preview or thumbnail directly." }, { "name": "Rendition", "description": "A generated derivative of a file version - e.g. a thumbnail, resized preview, or converted format - produced automatically by DAM's media processing pipeline." }, { "name": "Rule", "description": "An automation that runs a set of actions when its trigger fires and its conditions match (e.g. on record creation) - used to automate DAM workflows such as classification, notification, or field population." }, { "name": "Search", "description": "Full-text and suggestion search across records, classifications, and images." }, { "name": "Search index", "description": "Status of the tenant's record/classification search index - rebuild progress, indexed counts, and pending changes - used to monitor and trigger reindexing." }, { "name": "Setting", "description": "Represents a single setting in DAM. Because settings can contain sensitive information, an additional security measure is present in the REST API preventing access to settings unless explicitly allowed by the DAM administrator. In order to access (read/write) any of the settings in DAM, the administrator first needs to configure an allowlist of all the settings allowed to be accessed through the REST API. This allowlist is a system setting in DAM, named '.rest_SettingsWhitelist', in the form of a comma-separated list of allowed setting names, and can be updated through the System Studio. However, the allowlist does not affect users from the DAM Administrator user group: they have access to all their DAM settings, irrespective of the allowlist. After the allowlist has been properly configured, consumers can access the settings specified in the allowlist via the REST API." }, { "name": "Setting category", "description": "A named grouping used to organize related system settings for display, e.g. in Config Studio." }, { "name": "Setting definition", "description": "Defines the schema (name, data type, category) of a system setting, which can then be read or written via the Settings endpoints, subject to the settings whitelist." }, { "name": "Shared download link", "description": "A link to a set of files, sent by email to a specific recipient, with an optional expiration date and email-verification-code requirement - a more controlled alternative to a plain public link for sharing downloads with a named person." }, { "name": "Subscription", "description": "A user's opt-in to be notified about changes to a specific object (e.g. a record or collection) - links a user, the object, and the kind of change they want to be notified about." }, { "name": "Supported version", "description": "The REST API versions currently supported by this server." }, { "name": "Translation", "description": "A localized text value (e.g. a UI label or field name) for a given translation key and language, used to support multi-language display in the DAM UI." }, { "name": "Unique key index", "description": "Status of the unique-key index, which enforces uniqueness for fields configured as unique keys across records and classifications - rebuild progress and duplicate detection." }, { "name": "User", "description": "A DAM user account. Users authenticate to the API, hold permission grants, and are recorded as the creator/modifier of other resources." }, { "name": "User group", "description": "A named collection of users, used to grant permissions or access lists to many users at once instead of assigning them individually." }, { "name": "Watermark", "description": "A transparent overlay image (e.g. a logo or copyright mark) that can be applied on top of another image via a rule action or a resize/watermark operation." } ] }