{"items":[{"type":"link","label":"Sales Layer DAM REST API","link":"/apis/dam-v2.0","routeSlug":"/apis/dam-v2.0","content":{"contentType":"overview","meta":{"name":"Sales Layer DAM REST API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"dam-v2.0.json","url":"/_bundle/apis/dam-v2.0.json?download"},{"kind":"download","label":"dam-v2.0.yaml","url":"/_bundle/apis/dam-v2.0.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://api2.saleslayer.com/dam","description":"Sales Layer DAM API"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Sales Layer DAM REST API (2.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Sales Layer DAM REST API lets external systems work with digital assets managed by Sales Layer: images and non-image files (documents, spreadsheets, archives, and more)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this reference when you need to create, list, filter, retrieve, update, or delete image or file records — including registering assets from public URLs, replacing their source content or tags, and removing assets that are no longer required by your catalog workflows."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DAM operations are designed for integrations that keep media libraries, product imagery, product documentation, commerce platforms, supplier portals, and other business systems aligned with Sales Layer. For implementation guidance, review the authentication, pagination, rate limiting, and error handling guides before calling the endpoints below."},"children":[]}]}]}]}],"sectionId":"/apis/dam-v2.0"}],"sectionId":"/apis/dam-v2.0"}]}]}},{"type":"group","label":"Files","link":"/apis/dam-v2.0/files","routeSlug":"/apis/dam-v2.0/files","items":[{"label":"Filter Files","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/dam-v2.0/files/paths/~1files/get","routeSlug":"/apis/dam-v2.0/files/paths/~1files/get","metadata":{"seo":{"title":"Filter Files","description":"Returns a paginated collection of the tenant's non-image files (documents, spreadsheets, archives, …),filtered and sorted using OData query options ($filter, $orderby, $top, $skip)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Filter Files","isWebhook":false,"pointer":"/paths/~1files/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Filter Files","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a paginated collection of the tenant's non-image files (documents, spreadsheets, archives, …),"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"filtered and sorted using OData query options ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$filter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$orderby"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$top"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$skip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"files/paths/~1files/get/request/authentication","deepLinkHash":"/files/paths/~1files/get#files/paths/~1files/get/request/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires a valid API key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-API-KEY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"files/paths/~1files/get/request/response-(200-ok)","deepLinkHash":"/files/paths/~1files/get#files/paths/~1files/get/request/response-(200-ok)"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response (200 OK)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The page is wrapped in the house collection envelope — the files are under "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", never at the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"top level:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"value\": [\n    {\n      \"reference\": \"product-datasheet.pdf\",\n      \"numLinks\": 3,\n      \"status\": \"Ok\",\n      \"modifiedOn\": \"2024-04-05T08:44:33\",\n      \"fileType\": \"pdf\",\n      \"createdOn\": \"2024-04-05T08:44:33\",\n      \"tags\": [\"datasheets\", \"catalog\"],\n      \"url\": \"https://cdn.example.com/product-datasheet.pdf\",\n      \"sizeInBytes\": 102400\n    }\n  ],\n  \"@count\": 137,\n  \"@readLink\": \"https://api2.saleslayer.com/dam/files?$top=50\",\n  \"@nextLink\": \"https://api2.saleslayer.com/dam/files?$top=50&$skip=50\"\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"value\": [\n    {\n      \"reference\": \"product-datasheet.pdf\",\n      \"numLinks\": 3,\n      \"status\": \"Ok\",\n      \"modifiedOn\": \"2024-04-05T08:44:33\",\n      \"fileType\": \"pdf\",\n      \"createdOn\": \"2024-04-05T08:44:33\",\n      \"tags\": [\"datasheets\", \"catalog\"],\n      \"url\": \"https://cdn.example.com/product-datasheet.pdf\",\n      \"sizeInBytes\": 102400\n    }\n  ],\n  \"@count\": 137,\n  \"@readLink\": \"https://api2.saleslayer.com/dam/files?$top=50\",\n  \"@nextLink\": \"https://api2.saleslayer.com/dam/files?$top=50&$skip=50\"\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes on the payload:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" tells you whether the file is usable yet — see the status values below."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sizeInBytes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" come from the stored metadata and are empty / "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" until processing has"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"recorded them."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is stored as a comma-separated string, so a tag that itself contains a comma comes back"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"split into several tags."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"@count"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the total number of matches, ignoring "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$top"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$skip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"@readLink"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the canonical URL of this collection — this request, echoed back."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"@nextLink"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the URL of the next page and is omitted on the last page."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"@"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-prefixed hypermedia links ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"@readLink"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"@nextLink"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") are only emitted when hypermedia"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"enrichment is configured for the deployment; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"@count"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is always present. Where the links are"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"absent, page forward by incrementing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$skip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" yourself until fewer than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$top"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" items come back."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"files/paths/~1files/get/request/supported-fields","deepLinkHash":"/files/paths/~1files/get#files/paths/~1files/get/request/supported-fields"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported fields"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only these fields can be used in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$filter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$orderby"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"numLinks"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"modifiedOn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fileType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdOn"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field names are case-insensitive. Every other field — including "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sizeInBytes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" queryable: naming one in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$filter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$orderby"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returns 400."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$orderby"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" honours only the first sort expression."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$select"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$expand"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are not supported and are ignored."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"files/paths/~1files/get/request/supported-operators-and-functions","deepLinkHash":"/files/paths/~1files/get#files/paths/~1files/get/request/supported-operators-and-functions"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported operators and functions"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comparison: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eq"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ne"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"le"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Logical: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"and"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"or"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"not"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sets: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"in"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Functions: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startswith"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endswith"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"files/paths/~1files/get/request/status-field-values","deepLinkHash":"/files/paths/~1files/get#files/paths/~1files/get/request/status-field-values"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status field values"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Vd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Void (not yet started processing)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Up"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Updating (being uploaded/updated)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Ok"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Processed correctly (ready to use)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Re"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Reprocessing"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Er"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Error (processing failed)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dv"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Deleted/void"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Results are not filtered by status, so files in any of these states can be returned. Filter on"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explicitly if you only want usable files."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"files/paths/~1files/get/request/examples","deepLinkHash":"/files/paths/~1files/get#files/paths/~1files/get/request/examples"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"GET /files?$filter=fileType eq 'pdf'\nGET /files?$filter=status eq 'Ok'\nGET /files?$filter=fileType eq 'csv' and status eq 'Ok'\nGET /files?$filter=status in ('Ok', 'Re')\nGET /files?$filter=contains(reference, 'datasheet')\nGET /files?$filter=startswith(reference, 'product-') and numLinks gt 0\nGET /files?$orderby=createdOn desc\nGET /files?$filter=fileType ne 'txt'&$orderby=numLinks desc&$skip=0&$top=50\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET /files?$filter=fileType eq 'pdf'\nGET /files?$filter=status eq 'Ok'\nGET /files?$filter=fileType eq 'csv' and status eq 'Ok'\nGET /files?$filter=status in ('Ok', 'Re')\nGET /files?$filter=contains(reference, 'datasheet')\nGET /files?$filter=startswith(reference, 'product-') and numLinks gt 0\nGET /files?$orderby=createdOn desc\nGET /files?$filter=fileType ne 'txt'&$orderby=numLinks desc&$skip=0&$top=50\n"},"children":[]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"files/paths/~1files/get/request/error-responses","deepLinkHash":"/files/paths/~1files/get#files/paths/~1files/get/request/error-responses"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error Responses"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400 Bad Request"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Invalid "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$filter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" syntax, a field that is not queryable in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$filter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$orderby"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", a negative "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$skip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$top"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that is not between 1 and 100"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"401 Unauthorized"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Missing or invalid API key. Returned by the API gateway as"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ \"message\": \"Unauthorized\", \"request_id\": \"d8aafa5b8f3e400b60bea0123dd33317\" }"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"403 Forbidden"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The API key does not have read permissions for this operation. Same body"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"shape as the 401"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"500 Internal Server Error"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Technical error (e.g. database unavailable)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A 400 uses the shared validation envelope, keyed by the offending parameter:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"validationFailures\": {\n    \"$orderby\": [\n      {\n        \"PropertyName\": \"$orderby\",\n        \"ErrorMessage\": \"Ordering by 'tags' is not supported. Supported fields: reference, numlinks, status, modifiedon, filetype, createdon (Parameter 'propertyName')\",\n        \"AttemptedValue\": null\n      }\n    ]\n  }\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"validationFailures\": {\n    \"$orderby\": [\n      {\n        \"PropertyName\": \"$orderby\",\n        \"ErrorMessage\": \"Ordering by 'tags' is not supported. Supported fields: reference, numlinks, status, modifiedon, filetype, createdon (Parameter 'propertyName')\",\n        \"AttemptedValue\": null\n      }\n    ]\n  }\n}\n"},"children":[]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"$filter","in":"query","schemaId":"schema_12","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OData $filter expression — see the supported fields, operators and functions below"},"children":[]}]}]}]},{"name":"$orderby","in":"query","schemaId":"schema_12","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OData $orderby expression — only the fields listed below are supported"},"children":[]}]}]}]},{"name":"$top","in":"query","schemaId":"schema_13","description":"Maximum number of records to return (default: 100, max: 100)"},{"name":"$skip","in":"query","schemaId":"schema_13","description":"Number of records to skip for pagination (default: 0)"}],"pointer":"/paths/~1files/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-API-KEY","in":"header","schemaId":"schema_12","description":"Tenant's API key (required)","required":true}],"pointer":"/paths/~1files/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/files","servers":[{"url":"https://api2.saleslayer.com/dam","description":"Sales Layer DAM API"}],"parameters":{"path":[],"query":[{"name":"$filter","in":"query","schemaId":"schema_12"},{"name":"$orderby","in":"query","schemaId":"schema_12"},{"name":"$top","in":"query","schemaId":"schema_13"},{"name":"$skip","in":"query","schemaId":"schema_13"}],"querystring":[],"header":[{"name":"X-API-KEY","in":"header","required":true,"schemaId":"schema_12"}],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","500"],"pointer":"/files","href":"files/paths/~1files/get","summary":"Filter Files"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api2.saleslayer.com/dam","description":"Sales Layer DAM API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FileCollectionRepresentation"}},"schemaId":"components/schemas/FileCollectionRepresentation"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailureRepresentation"}},"schemaId":"components/schemas/ValidationFailureRepresentation"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedRepresentation"}},"schemaId":"components/schemas/UnauthorizedRepresentation"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenRepresentation"}},"schemaId":"components/schemas/ForbiddenRepresentation"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorRepresentation"}},"schemaId":"components/schemas/ErrorRepresentation"}],"pointer":"/paths/~1files/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/FileCollectionRepresentation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FileCollectionRepresentation"}}},{"code":"400","schemaId":"components/schemas/ValidationFailureRepresentation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailureRepresentation"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedRepresentation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedRepresentation"}}},{"code":"403","schemaId":"components/schemas/ForbiddenRepresentation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenRepresentation"}}},{"code":"500","schemaId":"components/schemas/ErrorRepresentation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorRepresentation"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/files/paths/~1files/get"}],"panels":[]}]},"httpPath":"/files"},{"label":"Create File","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/dam-v2.0/files/paths/~1files/post","routeSlug":"/apis/dam-v2.0/files/paths/~1files/post","metadata":{"seo":{"title":"Create File","description":"Registers a new file from a publicly accessible URL, optionally tagging it. The file is fetched, checked against the supported formats and the size limit, and stored."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create File","isWebhook":false,"pointer":"/paths/~1files/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create File","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Registers a new file from a publicly accessible URL, optionally tagging it. The file is fetched, checked against the supported formats and the size limit, and stored."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"files/paths/~1files/post/request/authentication","deepLinkHash":"/files/paths/~1files/post#files/paths/~1files/post/request/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires a valid API key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-API-KEY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"files/paths/~1files/post/request/request-body","deepLinkHash":"/files/paths/~1files/post#files/paths/~1files/post/request/request-body"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request Body"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"url\": \"https://example.com/docs/product-datasheet.pdf\",\n  \"tags\": [\"datasheets\", \"catalog\", \"summer-2024\"]\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"url\": \"https://example.com/docs/product-datasheet.pdf\",\n  \"tags\": [\"datasheets\", \"catalog\", \"summer-2024\"]\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"files/paths/~1files/post/request/url-field-(required)","deepLinkHash":"/files/paths/~1files/post#files/paths/~1files/post/request/url-field-(required)"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL Field (Required)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The URL must meet the following requirements:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid URL formats:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be a valid HTTP or HTTPS URL"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be absolute (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://example.com/manual.pdf"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Relative URLs are NOT supported (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/docs/manual.pdf"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The filename is taken from the URL path and becomes the file's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples of valid URLs:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"https://example.com/product-datasheet.pdf\nhttps://cdn.example.com/docs/2024/manual.docx\nhttp://assets.example.com/exports/catalog_123.csv\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"https://example.com/product-datasheet.pdf\nhttps://cdn.example.com/docs/2024/manual.docx\nhttp://assets.example.com/exports/catalog_123.csv\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples of invalid URLs:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"/docs/manual.pdf                       (relative URL)\nexample.com/manual.pdf                 (missing protocol)\nftp://server.com/manual.pdf            (FTP not supported)\nhttps://example.com/installer.exe      (extension not accepted)\nhttps://example.com/datasheet          (no extension to derive the file type from)\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"/docs/manual.pdf                       (relative URL)\nexample.com/manual.pdf                 (missing protocol)\nftp://server.com/manual.pdf            (FTP not supported)\nhttps://example.com/installer.exe      (extension not accepted)\nhttps://example.com/datasheet          (no extension to derive the file type from)\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL validation rules:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum length: 2048 characters"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The URL must be publicly accessible (no authentication supported)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The host must resolve to a public address. URLs pointing at loopback, private ranges or the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cloud metadata endpoint are rejected"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The URL is probed with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HEAD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request; anything other than a 2xx is rejected"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An address that never answers, or that refuses the connection, is rejected the same way — as an"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"address the caller has to correct, not as a technical error"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"files/paths/~1files/post/request/tags-field-(optional)","deepLinkHash":"/files/paths/~1files/post#files/paths/~1files/post/request/tags-field-(optional)"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags Field (Optional)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional array of strings to categorize and organize your files."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rules:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each tag cannot be empty or contain only whitespace"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags are case-sensitive"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No tag may contain a comma. A comma is the separator the set is stored with, so a tag carrying"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"one would be read back as two; it is rejected rather than accepted and mangled"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There is no explicit limit on the number of tags, but the whole comma-separated list must fit in"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"64 KB of storage"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"files/paths/~1files/post/request/supported-file-formats","deepLinkHash":"/files/paths/~1files/post#files/paths/~1files/post/request/supported-file-formats"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported File Formats"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The file type is taken from the URL's file extension and must be one of:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Category"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Extensions"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Documents"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pdf"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"doc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"docx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"txt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rtf"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"odt"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Spreadsheets"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"xls"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"xlsx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"csv"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ods"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Presentations"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ppt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pptx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"odp"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Archives"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"zip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rar"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"7z"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tar"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gz"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tgz"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Video and audio"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mp4"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mov"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"webm"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"m4v"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mpeg"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mpg"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"avi"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mp3"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"wav"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Images"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"jpg"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"jpeg"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"png"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gif"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bmp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tif"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tiff"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"psd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"webp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"avif"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"heic"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Markup and data"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"svg"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"html"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"htm"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"xml"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"json"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Print production"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ai"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eps"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"indd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"idml"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"idms"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CAD, BIM and 3D"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dwg"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dxf"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"step"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"iges"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"igs"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"obj"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mtl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fbx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"3ds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"max"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"skp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"glb"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gltf"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"usdz"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dae"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"3dm"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x3d"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ifc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rfa"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rvt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"iam"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ipt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"idw"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Photometry and product data"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ldt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uld"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gll"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gdtf"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bc3"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bom"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sup"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fonts"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"otf"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ttf"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"woff"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"woff2"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The extension is matched case-insensitively and decides which format the file is filed as. The"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the URL serves is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" validated, unlike "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /images"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": several of the accepted"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"formats have no registered media type and are commonly served as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/octet-stream"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", so a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"media-type allow-list would reject valid uploads without excluding anything."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"files/paths/~1files/post/request/file-size-limit","deepLinkHash":"/files/paths/~1files/post#files/paths/~1files/post/request/file-size-limit"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"File Size Limit"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum file size:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 250 MB (262,144,000 bytes)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The transfer is cut off as soon as the limit is exceeded, so an oversized file is never stored"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"files/paths/~1files/post/request/response","deepLinkHash":"/files/paths/~1files/post#files/paths/~1files/post/request/response"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response"},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"files/paths/~1files/post/request/success-response-(201-created)","deepLinkHash":"/files/paths/~1files/post#files/paths/~1files/post/request/success-response-(201-created)"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Success Response (201 Created)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the reference (filename) of the created file, wrapped in the house entity envelope. The"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"reference is the public, tenant-unique key; the numeric id is internal only and is not exposed:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"value\": {\n    \"reference\": \"product-datasheet.pdf\"\n  },\n  \"@readLink\": \"https://api2.saleslayer.com/dam/files(product-datasheet.pdf)\",\n  \"@editLink\": \"https://api2.saleslayer.com/dam/files(product-datasheet.pdf)\"\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"value\": {\n    \"reference\": \"product-datasheet.pdf\"\n  },\n  \"@readLink\": \"https://api2.saleslayer.com/dam/files(product-datasheet.pdf)\",\n  \"@editLink\": \"https://api2.saleslayer.com/dam/files(product-datasheet.pdf)\"\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"files/paths/~1files/post/request/error-responses","deepLinkHash":"/files/paths/~1files/post#files/paths/~1files/post/request/error-responses"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error Responses"},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"files/paths/~1files/post/request/400-bad-request","deepLinkHash":"/files/paths/~1files/post#files/paths/~1files/post/request/400-bad-request"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400 Bad Request"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validation failures are returned in the shared envelope. Service-level messages carry no field"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"context, so they are grouped under a generic "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" key:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"validationFailures\": {\n    \"error\": [\"URL is required\"]\n  }\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"validationFailures\": {\n    \"error\": [\"URL is required\"]\n  }\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The messages you can receive, verbatim:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cause"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Message"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or empty URL"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"URL is required"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL over 2048 characters"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"URL exceeds maximum length of 2048 characters"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not an absolute URL"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"URL is not valid"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scheme other than HTTP/HTTPS"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"URL must use HTTP or HTTPS protocol"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No extension in the URL path"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Could not determine file type from URL. Please ensure the URL contains a filename with an extension."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unsupported extension"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"File extension 'exe' is not allowed. Allowed extensions: 3dm, 3ds, 7z, ai, avi, ..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — the whole accepted set, alphabetically"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Host is not publicly routable"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"URL host 'localhost' is not allowed."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL not reachable (non-2xx "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HEAD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"URL is not accessible. HTTP status: 404 Not Found"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL did not answer in time"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"URL is not accessible. The address did not respond in time."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Connection refused, DNS or TLS failure"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"URL is not accessible. The address 'cdn.example.com' could not be reached."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Empty file"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"The uploaded file is empty"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stored copy missing"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"The uploaded file could not be found in storage."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"File too large"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"File size (300.00 MB) exceeds maximum allowed size of 250 MB"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Content is a different file type"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"The address serves a PNG image, but the file name 'product-datasheet.pdf' announces a 'pdf' file."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Content matches no known file type"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"The address does not serve a 'pdf' file: its content matches no known file type."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Empty or whitespace-only tag"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Tags cannot contain empty values"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tag containing a comma"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Tags cannot contain commas"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"files/paths/~1files/post/request/401-unauthorized","deepLinkHash":"/files/paths/~1files/post#files/paths/~1files/post/request/401-unauthorized"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"401 Unauthorized"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-API-KEY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Emitted by the API gateway:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"message\": \"Unauthorized\",\n  \"request_id\": \"d8aafa5b8f3e400b60bea0123dd33317\"\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"message\": \"Unauthorized\",\n  \"request_id\": \"d8aafa5b8f3e400b60bea0123dd33317\"\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"files/paths/~1files/post/request/403-forbidden","deepLinkHash":"/files/paths/~1files/post#files/paths/~1files/post/request/403-forbidden"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"403 Forbidden"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The API key does not have write permissions for this operation. Same body shape as the 401."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"files/paths/~1files/post/request/409-conflict","deepLinkHash":"/files/paths/~1files/post#files/paths/~1files/post/request/409-conflict"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"409 Conflict"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Two distinct causes, both using the conflict envelope:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A file with the same filename ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") already exists for this tenant:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"error\": \"A file with the filename 'product-datasheet.pdf' already exists\"\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"error\": \"A file with the filename 'product-datasheet.pdf' already exists\"\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The tenant has reached its file-library quota:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"error\": \"File library limit reached. Current: 500, Maximum: 500\"\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"error\": \"File library limit reached. Current: 500, Maximum: 500\"\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deleted files do not count towards the quota. Delete unused files to free"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"capacity, or contact Sales Layer to raise the limit. The file and image libraries have separate"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"quotas, so files never consume image capacity or vice versa."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"files/paths/~1files/post/request/complete-example","deepLinkHash":"/files/paths/~1files/post#files/paths/~1files/post/request/complete-example"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Complete Example"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"POST /files HTTP/1.1\nHost: api2.saleslayer.com\nX-API-KEY: your-api-key-here\nContent-Type: application/json\n            \n{\n  \"url\": \"https://cdn.example.com/docs/2024/product-datasheet.pdf\",\n  \"tags\": [\"datasheets\", \"catalog\"]\n}\n","language":"http"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST /files HTTP/1.1\nHost: api2.saleslayer.com\nX-API-KEY: your-api-key-here\nContent-Type: application/json\n            \n{\n  \"url\": \"https://cdn.example.com/docs/2024/product-datasheet.pdf\",\n  \"tags\": [\"datasheets\", \"catalog\"]\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Success Response:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"HTTP/1.1 201 Created\nContent-Type: application/json\nLocation: https://api2.saleslayer.com/dam/files(product-datasheet.pdf)\n            \n{\n  \"value\": {\n    \"reference\": \"product-datasheet.pdf\"\n  }\n}\n","language":"http"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"HTTP/1.1 201 Created\nContent-Type: application/json\nLocation: https://api2.saleslayer.com/dam/files(product-datasheet.pdf)\n            \n{\n  \"value\": {\n    \"reference\": \"product-datasheet.pdf\"\n  }\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Result:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"value\": {\n    \"reference\": \"product-datasheet.pdf\",\n    \"status\": \"Ok\",\n    \"fileType\": \"pdf\",\n    \"sizeInBytes\": 524288,\n    \"numLinks\": 0,\n    \"tags\": [\"datasheets\", \"catalog\"],\n    \"url\": \"https://cdn.example.com/CMP2009/files/product-datasheet.pdf\",\n    \"createdOn\": \"2024-04-02T10:30:00\",\n    \"modifiedOn\": \"2024-04-02T10:30:00\"\n  }\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"value\": {\n    \"reference\": \"product-datasheet.pdf\",\n    \"status\": \"Ok\",\n    \"fileType\": \"pdf\",\n    \"sizeInBytes\": 524288,\n    \"numLinks\": 0,\n    \"tags\": [\"datasheets\", \"catalog\"],\n    \"url\": \"https://cdn.example.com/CMP2009/files/product-datasheet.pdf\",\n    \"createdOn\": \"2024-04-02T10:30:00\",\n    \"modifiedOn\": \"2024-04-02T10:30:00\"\n  }\n}\n"},"children":[]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-API-KEY","in":"header","schemaId":"schema_12","description":"Tenant's API key (required)","required":true}],"pointer":"/paths/~1files/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateFileRequest"},"text/json":{"schemaId":"components/schemas/CreateFileRequest"},"application/*+json":{"schemaId":"components/schemas/CreateFileRequest"}},"schemaId":"components/schemas/CreateFileRequest","pointer":"/paths/~1files/post/requestBody","description":"Request containing the file URL and optional tags"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/files","servers":[{"url":"https://api2.saleslayer.com/dam","description":"Sales Layer DAM API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-API-KEY","in":"header","required":true,"schemaId":"schema_12"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateFileRequest"},"text/json":{"schemaId":"components/schemas/CreateFileRequest"},"application/*+json":{"schemaId":"components/schemas/CreateFileRequest"}},"responseCodes":["201","400","401","403","409","500"],"pointer":"/files","href":"files/paths/~1files/post","summary":"Create File"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api2.saleslayer.com/dam","description":"Sales Layer DAM API"}],"schemaId":"components/schemas/CreateFileRequest","mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateFileRequest"},"text/json":{"schemaId":"components/schemas/CreateFileRequest"},"application/*+json":{"schemaId":"components/schemas/CreateFileRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreatedFileRepresentation"}},"schemaId":"components/schemas/CreatedFileRepresentation"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailureRepresentation"}},"schemaId":"components/schemas/ValidationFailureRepresentation"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedRepresentation"}},"schemaId":"components/schemas/UnauthorizedRepresentation"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenRepresentation"}},"schemaId":"components/schemas/ForbiddenRepresentation"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConflictRepresentation"}},"schemaId":"components/schemas/ConflictRepresentation"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorRepresentation"}},"schemaId":"components/schemas/ErrorRepresentation"}],"pointer":"/paths/~1files/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/CreatedFileRepresentation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreatedFileRepresentation"}}},{"code":"400","schemaId":"components/schemas/ValidationFailureRepresentation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailureRepresentation"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedRepresentation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedRepresentation"}}},{"code":"403","schemaId":"components/schemas/ForbiddenRepresentation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenRepresentation"}}},{"code":"409","schemaId":"components/schemas/ConflictRepresentation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConflictRepresentation"}}},{"code":"500","schemaId":"components/schemas/ErrorRepresentation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorRepresentation"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/files/paths/~1files/post"}],"panels":[]}]},"httpPath":"/files"},{"label":"Get File","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/dam-v2.0/files/paths/~1files({reference})/get","routeSlug":"/apis/dam-v2.0/files/paths/~1files({reference})/get","metadata":{"seo":{"title":"Get File","description":"In DAM, files are identified by their filename (reference), which is unique per tenant.Use this endpoint to retrieve a specific file when you already know its filename."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Get File","isWebhook":false,"pointer":"/paths/~1files({reference})/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get File","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In DAM, files are identified by their filename ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), which is unique per tenant."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this endpoint to retrieve a specific file when you already know its filename."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"files/paths/~1files({reference})/get/request/authentication","deepLinkHash":"/files/paths/~1files({reference})/get#files/paths/~1files({reference})/get/request/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires a valid API key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-API-KEY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"files/paths/~1files({reference})/get/request/example","deepLinkHash":"/files/paths/~1files({reference})/get#files/paths/~1files({reference})/get/request/example"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"GET /files(product-datasheet.pdf)\nX-API-KEY: your-api-key-here\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET /files(product-datasheet.pdf)\nX-API-KEY: your-api-key-here\n"},"children":[]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"files/paths/~1files({reference})/get/request/response-(200-ok)","deepLinkHash":"/files/paths/~1files({reference})/get#files/paths/~1files({reference})/get/request/response-(200-ok)"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response (200 OK)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The file is wrapped in the house entity envelope — its fields are under "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", never at the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"top level:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"value\": {\n    \"reference\": \"product-datasheet.pdf\",\n    \"numLinks\": 3,\n    \"status\": \"Ok\",\n    \"modifiedOn\": \"2024-04-05T08:44:33\",\n    \"fileType\": \"pdf\",\n    \"createdOn\": \"2024-04-05T08:44:33\",\n    \"tags\": [\"datasheets\", \"catalog\"],\n    \"url\": \"https://cdn.example.com/product-datasheet.pdf\",\n    \"sizeInBytes\": 102400\n  },\n  \"@readLink\": \"https://api2.saleslayer.com/dam/files(product-datasheet.pdf)\",\n  \"@editLink\": \"https://api2.saleslayer.com/dam/files(product-datasheet.pdf)\"\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"value\": {\n    \"reference\": \"product-datasheet.pdf\",\n    \"numLinks\": 3,\n    \"status\": \"Ok\",\n    \"modifiedOn\": \"2024-04-05T08:44:33\",\n    \"fileType\": \"pdf\",\n    \"createdOn\": \"2024-04-05T08:44:33\",\n    \"tags\": [\"datasheets\", \"catalog\"],\n    \"url\": \"https://cdn.example.com/product-datasheet.pdf\",\n    \"sizeInBytes\": 102400\n  },\n  \"@readLink\": \"https://api2.saleslayer.com/dam/files(product-datasheet.pdf)\",\n  \"@editLink\": \"https://api2.saleslayer.com/dam/files(product-datasheet.pdf)\"\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes on the payload:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" tells you whether the file is usable yet — see the status values documented on"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /files"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sizeInBytes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" come from the stored metadata and are empty / "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" until processing has"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"recorded them."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is stored as a comma-separated string, so a tag that itself contains a comma comes back"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"split into several tags."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"@readLink"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"@editLink"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are the canonical URL of this file (this request, echoed back), and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"are only emitted when hypermedia enrichment is configured for the deployment."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"files/paths/~1files({reference})/get/request/error-responses","deepLinkHash":"/files/paths/~1files({reference})/get#files/paths/~1files({reference})/get/request/error-responses"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error Responses"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"401 Unauthorized"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Missing or invalid API key. Returned by the API gateway as"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ \"message\": \"Unauthorized\", \"request_id\": \"d8aafa5b8f3e400b60bea0123dd33317\" }"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"403 Forbidden"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The API key does not have read permissions for this operation. Same body"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"shape as the 401"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"404 Not Found"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": No file with the given reference exists for this tenant. The body is the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"message string, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"File with reference 'missing.pdf' was not found.\""},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"500 Internal Server Error"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Technical error (e.g. database unavailable)"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"reference","in":"path","schemaId":"schema_12","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"File name, unique per tenant (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"product-datasheet.pdf"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1files({reference})/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-API-KEY","in":"header","schemaId":"schema_12","description":"Tenant's API key (required)","required":true}],"pointer":"/paths/~1files({reference})/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/files({reference})","servers":[{"url":"https://api2.saleslayer.com/dam","description":"Sales Layer DAM API"}],"parameters":{"path":[{"name":"reference","in":"path","required":true,"schemaId":"schema_12"}],"query":[],"querystring":[],"header":[{"name":"X-API-KEY","in":"header","required":true,"schemaId":"schema_12"}],"cookie":[]},"security":[],"responseCodes":["200","401","403","404","500"],"pointer":"/files({reference})","href":"files/paths/~1files({reference})/get","summary":"Get File"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api2.saleslayer.com/dam","description":"Sales Layer DAM API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FileEntityRepresentation"}},"schemaId":"components/schemas/FileEntityRepresentation"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedRepresentation"}},"schemaId":"components/schemas/UnauthorizedRepresentation"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenRepresentation"}},"schemaId":"components/schemas/ForbiddenRepresentation"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_12"}},"schemaId":"schema_12"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorRepresentation"}},"schemaId":"components/schemas/ErrorRepresentation"}],"pointer":"/paths/~1files({reference})/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/FileEntityRepresentation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FileEntityRepresentation"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedRepresentation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedRepresentation"}}},{"code":"403","schemaId":"components/schemas/ForbiddenRepresentation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenRepresentation"}}},{"code":"404","schemaId":"schema_12","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_12"}}},{"code":"500","schemaId":"components/schemas/ErrorRepresentation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorRepresentation"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/files/paths/~1files({reference})/get"}],"panels":[]}]},"httpPath":"/files({reference})"},{"label":"Patch File","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/dam-v2.0/files/paths/~1files({reference})/patch","routeSlug":"/apis/dam-v2.0/files/paths/~1files({reference})/patch","metadata":{"seo":{"title":"Patch File","description":"Partially updates an existing file identified by its filename (reference), which is unique per tenant — substitute its contents via a new url and/or replace its tags. At least one of these fields must be supplied."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Patch File","isWebhook":false,"pointer":"/paths/~1files({reference})/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Patch File","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Partially updates an existing file identified by its filename ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), which is unique per tenant — substitute its contents via a new "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and/or replace its "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". At least one of these fields must be supplied."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The replacement "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can point at a file with any name — the contents are "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"always stored under the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"file's current "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", because that filename is how the rest of the platform points at the file"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and a substitution cannot rename it. What the replacement "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cannot"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" change is the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"file type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"file would end up served under a name that misdescribes it."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"That type is decided by "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the content of the file"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", not by the extension in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": the extension"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is yours to write and any file can be published under any name, so it proves nothing. The extension"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"still has to be one "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /files"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" accepts, but the bytes are what settle the type. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /files"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"reads the bytes the same way; there the type they are held to is the one the new file name announces,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here it is the type the file already has."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"PATCH /files(product-datasheet.pdf)\n{ \"url\": \"https://cdn.example.com/docs/v2/product-datasheet.pdf\" }   OK   same name, PDF content\n{ \"url\": \"https://cdn.example.com/exports/9f21b0-final.pdf\" }        OK   any name, PDF content\n{ \"url\": \"https://cdn.example.com/docs/product-datasheet.docx\" }     400  content is not a PDF\n{ \"url\": \"https://cdn.example.com/docs/product-datasheet.pdf\" }      400  named .pdf, but not a PDF\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PATCH /files(product-datasheet.pdf)\n{ \"url\": \"https://cdn.example.com/docs/v2/product-datasheet.pdf\" }   OK   same name, PDF content\n{ \"url\": \"https://cdn.example.com/exports/9f21b0-final.pdf\" }        OK   any name, PDF content\n{ \"url\": \"https://cdn.example.com/docs/product-datasheet.docx\" }     400  content is not a PDF\n{ \"url\": \"https://cdn.example.com/docs/product-datasheet.pdf\" }      400  named .pdf, but not a PDF\n"},"children":[]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"files/paths/~1files({reference})/patch/request/changing-a-file's-type","deepLinkHash":"/files/paths/~1files({reference})/patch#files/paths/~1files({reference})/patch/request/changing-a-file's-type"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Changing a file's type"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not possible through a substitution, because the filename — and so the extension — is fixed. Do it"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"client-side in three steps:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create the new file"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /files"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with the new file's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Repoint the references"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — use the Catalog API to find every entity (product, variant, category, …)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"that uses the old filename and update it to the new one."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delete the old file"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DELETE /files({old-reference})"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" once nothing references it any more."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"files/paths/~1files({reference})/patch/request/fields","deepLinkHash":"/files/paths/~1files({reference})/patch#files/paths/~1files({reference})/patch/request/fields"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fields"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"url"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (optional): public URL of the new file. Triggers a full substitution. May be called"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"anything, but must serve a file of the current file type — see above. The address itself is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"validated exactly as on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /files"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", so only the extensions that endpoint accepts are allowed"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and the served "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not inspected."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"tags"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (optional): array of strings, validated exactly as on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /files"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Absent → tags are not modified, "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"including when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is supplied"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" → all tags are cleared."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[\"a\",\"b\"]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" → tags are replaced with these values."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"files/paths/~1files({reference})/patch/request/valid-combinations","deepLinkHash":"/files/paths/~1files({reference})/patch#files/paths/~1files({reference})/patch/request/valid-combinations"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid combinations"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Body"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Operation"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ \"url\": \"https://.../{any-filename}\" }"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Substitute file contents — "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"tags are kept"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ \"url\": \"https://.../{any-filename}\", \"tags\": [\"a\"] }"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Substitute contents and set tags"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ \"tags\": [\"a\"] }"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update tags only, file contents unchanged"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"files/paths/~1files({reference})/patch/request/invalid-combinations","deepLinkHash":"/files/paths/~1files({reference})/patch#files/paths/~1files({reference})/patch/request/invalid-combinations"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid combinations"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Empty body "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" → 400."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" serving content that is not of the current file type → 400 (see above)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"files/paths/~1files({reference})/patch/request/response-(204-no-content)","deepLinkHash":"/files/paths/~1files({reference})/patch#files/paths/~1files({reference})/patch/request/response-(204-no-content)"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response (204 No Content)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Success returns no body."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"files/paths/~1files({reference})/patch/request/notes","deepLinkHash":"/files/paths/~1files({reference})/patch#files/paths/~1files({reference})/patch/request/notes"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The replacement is live as soon as this returns."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A substitution does not change the file's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fileType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", so entities referencing it"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"keep working."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unlike the image endpoint this operation has no 409 conflict: only images are queued for"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"background processing, so a file is never locked by an in-flight process."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags behave as standard PATCH fields — absent means unchanged, exactly as on"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH /images({reference})"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"files/paths/~1files({reference})/patch/request/error-responses","deepLinkHash":"/files/paths/~1files({reference})/patch#files/paths/~1files({reference})/patch/request/error-responses"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error Responses"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400 Bad Request"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Invalid request body (e.g., both fields missing), a replacement whose content"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is not of the current "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fileType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or any of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" validation failures documented on"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /files"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (format, accessibility, extension, size). Same"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ \"validationFailures\": { \"error\": [...] } }"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" envelope"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"401 Unauthorized"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Missing or invalid API key. Returned by the API gateway as"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ \"message\": \"Unauthorized\", \"request_id\": \"d8aafa5b8f3e400b60bea0123dd33317\" }"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"403 Forbidden"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The API key does not have write permissions for this operation. Same body"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"shape as the 401"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"404 Not Found"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": No file with the given reference exists for this tenant. The body is the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"message string, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"File with reference 'missing.pdf' not found\""},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"500 Internal Server Error"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Technical error (network failure fetching the replacement file,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"storage or database unavailable). The already-uploaded replacement object is cleaned up, so the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"file is left on its previous contents"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"reference","in":"path","schemaId":"schema_12","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"File name (reference), unique per tenant (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"product-datasheet.pdf"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1files({reference})/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-API-KEY","in":"header","schemaId":"schema_12","description":"Tenant's API key (required)","required":true}],"pointer":"/paths/~1files({reference})/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PatchFileRequest"},"text/json":{"schemaId":"components/schemas/PatchFileRequest"},"application/*+json":{"schemaId":"components/schemas/PatchFileRequest"}},"schemaId":"components/schemas/PatchFileRequest","pointer":"/paths/~1files({reference})/patch/requestBody","description":"Fields to update. At least one of 'url' or 'tags' must be present."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/files({reference})","servers":[{"url":"https://api2.saleslayer.com/dam","description":"Sales Layer DAM API"}],"parameters":{"path":[{"name":"reference","in":"path","required":true,"schemaId":"schema_12"}],"query":[],"querystring":[],"header":[{"name":"X-API-KEY","in":"header","required":true,"schemaId":"schema_12"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/PatchFileRequest"},"text/json":{"schemaId":"components/schemas/PatchFileRequest"},"application/*+json":{"schemaId":"components/schemas/PatchFileRequest"}},"responseCodes":["204","400","401","403","404","500"],"pointer":"/files({reference})","href":"files/paths/~1files({reference})/patch","summary":"Patch File"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api2.saleslayer.com/dam","description":"Sales Layer DAM API"}],"schemaId":"components/schemas/PatchFileRequest","mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PatchFileRequest"},"text/json":{"schemaId":"components/schemas/PatchFileRequest"},"application/*+json":{"schemaId":"components/schemas/PatchFileRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailureRepresentation"}},"schemaId":"components/schemas/ValidationFailureRepresentation"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedRepresentation"}},"schemaId":"components/schemas/UnauthorizedRepresentation"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenRepresentation"}},"schemaId":"components/schemas/ForbiddenRepresentation"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_12"}},"schemaId":"schema_12"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorRepresentation"}},"schemaId":"components/schemas/ErrorRepresentation"}],"pointer":"/paths/~1files({reference})/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ValidationFailureRepresentation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailureRepresentation"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedRepresentation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedRepresentation"}}},{"code":"403","schemaId":"components/schemas/ForbiddenRepresentation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenRepresentation"}}},{"code":"404","schemaId":"schema_12","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_12"}}},{"code":"500","schemaId":"components/schemas/ErrorRepresentation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorRepresentation"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/files/paths/~1files({reference})/patch"}],"panels":[]}]},"httpPath":"/files({reference})"},{"label":"Delete File","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/dam-v2.0/files/paths/~1files({reference})/delete","routeSlug":"/apis/dam-v2.0/files/paths/~1files({reference})/delete","metadata":{"seo":{"title":"Delete File","description":"Deletes a file by its filename (reference), which is unique per tenant."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Delete File","isWebhook":false,"pointer":"/paths/~1files({reference})/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete File","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes a file by its filename ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), which is unique per tenant."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"files/paths/~1files({reference})/delete/request/authentication","deepLinkHash":"/files/paths/~1files({reference})/delete#files/paths/~1files({reference})/delete/request/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires a valid API key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-API-KEY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"files/paths/~1files({reference})/delete/request/example","deepLinkHash":"/files/paths/~1files({reference})/delete#files/paths/~1files({reference})/delete/request/example"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"DELETE /files(product-datasheet.pdf)\nX-API-KEY: your-api-key-here\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"DELETE /files(product-datasheet.pdf)\nX-API-KEY: your-api-key-here\n"},"children":[]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"files/paths/~1files({reference})/delete/request/response-(204-no-content)","deepLinkHash":"/files/paths/~1files({reference})/delete#files/paths/~1files({reference})/delete/request/response-(204-no-content)"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response (204 No Content)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Success returns no body."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"files/paths/~1files({reference})/delete/request/important:-deletion-does-not-cascade","deepLinkHash":"/files/paths/~1files({reference})/delete#files/paths/~1files({reference})/delete/request/important:-deletion-does-not-cascade"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Important: deletion does not cascade"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The file record is removed outright. The deletion is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" propagated to the entities that use"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the file — check "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"numLinks"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on the file first ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /files({reference})"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"): if it is greater than"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"zero, the products, variants and categories still referencing the filename will be left pointing"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"at a file that no longer exists. Repoint them via the Catalog API before deleting."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"files/paths/~1files({reference})/delete/request/error-responses","deepLinkHash":"/files/paths/~1files({reference})/delete#files/paths/~1files({reference})/delete/request/error-responses"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error Responses"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"401 Unauthorized"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Missing or invalid API key. Returned by the API gateway as"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ \"message\": \"Unauthorized\", \"request_id\": \"d8aafa5b8f3e400b60bea0123dd33317\" }"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"403 Forbidden"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The API key does not have write permissions for this operation. Same body"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"shape as the 401"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"404 Not Found"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": No file with the given reference exists for this tenant. The body is the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"message string, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"File with reference 'missing.pdf' not found\""},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"500 Internal Server Error"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Technical error (e.g. database unavailable)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unlike "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DELETE /images({reference})"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" this operation has no 409 conflict: only images are queued"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for background processing, so a file is never locked by an in-flight process."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"reference","in":"path","schemaId":"schema_12","description":"File name (reference), unique per tenant","required":true}],"pointer":"/paths/~1files({reference})/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-API-KEY","in":"header","schemaId":"schema_12","description":"Tenant's API key (required)","required":true}],"pointer":"/paths/~1files({reference})/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/files({reference})","servers":[{"url":"https://api2.saleslayer.com/dam","description":"Sales Layer DAM API"}],"parameters":{"path":[{"name":"reference","in":"path","required":true,"schemaId":"schema_12"}],"query":[],"querystring":[],"header":[{"name":"X-API-KEY","in":"header","required":true,"schemaId":"schema_12"}],"cookie":[]},"security":[],"responseCodes":["204","401","403","404","500"],"pointer":"/files({reference})","href":"files/paths/~1files({reference})/delete","summary":"Delete File"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api2.saleslayer.com/dam","description":"Sales Layer DAM API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedRepresentation"}},"schemaId":"components/schemas/UnauthorizedRepresentation"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenRepresentation"}},"schemaId":"components/schemas/ForbiddenRepresentation"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_12"}},"schemaId":"schema_12"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorRepresentation"}},"schemaId":"components/schemas/ErrorRepresentation"}],"pointer":"/paths/~1files({reference})/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/UnauthorizedRepresentation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedRepresentation"}}},{"code":"403","schemaId":"components/schemas/ForbiddenRepresentation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenRepresentation"}}},{"code":"404","schemaId":"schema_12","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_12"}}},{"code":"500","schemaId":"components/schemas/ErrorRepresentation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorRepresentation"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/files/paths/~1files({reference})/delete"}],"panels":[]}]},"httpPath":"/files({reference})"}],"content":{"contentType":"group","meta":{"name":"Files"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Files","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/files","summary":"Filter Files","prefix":{"name":"get","color":"get"},"badges":[],"link":"/files/paths/~1files/get","deprecated":false},{"title":"/files","summary":"Create File","prefix":{"name":"post","color":"post"},"badges":[],"link":"/files/paths/~1files/post","deprecated":false},{"title":"/files({reference})","summary":"Get File","prefix":{"name":"get","color":"get"},"badges":[],"link":"/files/paths/~1files({reference})/get","deprecated":false},{"title":"/files({reference})","summary":"Patch File","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/files/paths/~1files({reference})/patch","deprecated":false},{"title":"/files({reference})","summary":"Delete File","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/files/paths/~1files({reference})/delete","deprecated":false}]}]}]}]}},{"type":"group","label":"Images","link":"/apis/dam-v2.0/images","routeSlug":"/apis/dam-v2.0/images","items":[{"label":"Filter Images","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/dam-v2.0/images/paths/~1images/get","routeSlug":"/apis/dam-v2.0/images/paths/~1images/get","metadata":{"seo":{"title":"Filter Images","description":"Returns a paginated collection of the tenant's images, filtered and sorted using OData query options ($filter, $orderby, $top, $skip)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Filter Images","isWebhook":false,"pointer":"/paths/~1images/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Filter Images","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a paginated collection of the tenant's images, filtered and sorted using OData query options ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$filter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$orderby"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$top"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$skip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"images/paths/~1images/get/request/authentication","deepLinkHash":"/images/paths/~1images/get#images/paths/~1images/get/request/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires a valid API key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-API-KEY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"images/paths/~1images/get/request/response-(200-ok)","deepLinkHash":"/images/paths/~1images/get#images/paths/~1images/get/request/response-(200-ok)"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response (200 OK)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The page is wrapped in the house collection envelope — the images are under "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", never at the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"top level:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"value\": [\n    {\n      \"id\": 42,\n      \"reference\": \"product-main-front.jpg\",\n      \"numLinks\": 3,\n      \"status\": \"Ok\",\n      \"modifiedOn\": \"2024-04-05T08:44:33\",\n      \"fileType\": \"jpg\",\n      \"createdOn\": \"2024-04-05T08:44:33\",\n      \"tags\": [\"animales\", \"mascotas\"],\n      \"originalUrl\": \"https://cdn.example.com/product-main-front.jpg\",\n      \"thumbnailUrl\": \"https://cdn.example.com/product-main-front_TH.jpg\",\n      \"thumbnailMediumUrl\": \"https://cdn.example.com/product-main-front_THM.jpg\",\n      \"thumbnailPreviewUrl\": \"https://cdn.example.com/product-main-front_THP.jpg\",\n      \"width\": 800,\n      \"height\": 600,\n      \"sizeInBytes\": 102400\n    }\n  ],\n  \"@count\": 137,\n  \"@readLink\": \"https://api2.saleslayer.com/dam/images?$top=50\",\n  \"@nextLink\": \"https://api2.saleslayer.com/dam/images?$top=50&$skip=50\"\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"value\": [\n    {\n      \"id\": 42,\n      \"reference\": \"product-main-front.jpg\",\n      \"numLinks\": 3,\n      \"status\": \"Ok\",\n      \"modifiedOn\": \"2024-04-05T08:44:33\",\n      \"fileType\": \"jpg\",\n      \"createdOn\": \"2024-04-05T08:44:33\",\n      \"tags\": [\"animales\", \"mascotas\"],\n      \"originalUrl\": \"https://cdn.example.com/product-main-front.jpg\",\n      \"thumbnailUrl\": \"https://cdn.example.com/product-main-front_TH.jpg\",\n      \"thumbnailMediumUrl\": \"https://cdn.example.com/product-main-front_THM.jpg\",\n      \"thumbnailPreviewUrl\": \"https://cdn.example.com/product-main-front_THP.jpg\",\n      \"width\": 800,\n      \"height\": 600,\n      \"sizeInBytes\": 102400\n    }\n  ],\n  \"@count\": 137,\n  \"@readLink\": \"https://api2.saleslayer.com/dam/images?$top=50\",\n  \"@nextLink\": \"https://api2.saleslayer.com/dam/images?$top=50&$skip=50\"\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes on the payload:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" tells you whether the image is usable yet — see the status values documented on"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /images"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A freshly created or substituted image is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Up"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" until the worker finishes."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"width"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"height"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sizeInBytes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" come from the stored metadata and are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" until processing"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"has recorded them; the thumbnail URLs are empty until the renditions exist."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is stored as a comma-separated string, so a tag that itself contains a comma comes back"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"split into several tags."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"@count"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the total number of matches, ignoring "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$top"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$skip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"@readLink"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the canonical URL of this collection — this request, echoed back."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"@nextLink"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the URL of the next page and is omitted on the last page."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"@"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-prefixed hypermedia links ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"@readLink"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"@nextLink"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") are only emitted when hypermedia"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"enrichment is configured for the deployment; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"@count"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is always present. Where the links are"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"absent, page forward by incrementing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$skip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" yourself until fewer than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$top"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" items come back."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"images/paths/~1images/get/request/supported-fields","deepLinkHash":"/images/paths/~1images/get#images/paths/~1images/get/request/supported-fields"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported fields"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only these fields can be used in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$filter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$orderby"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"numLinks"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"modifiedOn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fileType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdOn"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field names are case-insensitive. Every other field of the response — including "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"width"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"height"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sizeInBytes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the URL fields — is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" queryable: naming one in"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$filter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$orderby"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returns 400. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$orderby"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" honours only the first sort expression."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$select"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$expand"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are not supported and are ignored."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"images/paths/~1images/get/request/supported-operators-and-functions","deepLinkHash":"/images/paths/~1images/get#images/paths/~1images/get/request/supported-operators-and-functions"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported operators and functions"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comparison: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eq"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ne"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"le"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Logical: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"and"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"or"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"not"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sets: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"in"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Functions: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startswith"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endswith"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"images/paths/~1images/get/request/status-field-values","deepLinkHash":"/images/paths/~1images/get#images/paths/~1images/get/request/status-field-values"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status field values"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Vd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Void (not yet started processing)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Up"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Updating (being uploaded/updated)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Ok"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Processed correctly (ready to use)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Re"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Reprocessing"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Er"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Error (processing failed)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dv"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Deleted/void (no longer counts towards the tenant's image-library quota)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Results are not filtered by status, so images in any of these states can be returned. Filter on"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explicitly if you only want usable images."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"images/paths/~1images/get/request/examples","deepLinkHash":"/images/paths/~1images/get#images/paths/~1images/get/request/examples"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"GET /images?$filter=fileType eq 'jpg'\nGET /images?$filter=status eq 'Ok'\nGET /images?$filter=fileType eq 'png' and status eq 'Ok'\nGET /images?$filter=status in ('Ok', 'Re')\nGET /images?$filter=contains(reference, 'product')\nGET /images?$filter=startswith(reference, 'product-') and numLinks gt 0\nGET /images?$orderby=createdOn desc\nGET /images?$filter=fileType ne 'gif'&$orderby=numLinks desc&$skip=0&$top=50\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET /images?$filter=fileType eq 'jpg'\nGET /images?$filter=status eq 'Ok'\nGET /images?$filter=fileType eq 'png' and status eq 'Ok'\nGET /images?$filter=status in ('Ok', 'Re')\nGET /images?$filter=contains(reference, 'product')\nGET /images?$filter=startswith(reference, 'product-') and numLinks gt 0\nGET /images?$orderby=createdOn desc\nGET /images?$filter=fileType ne 'gif'&$orderby=numLinks desc&$skip=0&$top=50\n"},"children":[]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"images/paths/~1images/get/request/error-responses","deepLinkHash":"/images/paths/~1images/get#images/paths/~1images/get/request/error-responses"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error Responses"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400 Bad Request"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Invalid "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$filter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" syntax, a field that is not queryable in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$filter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$orderby"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", a negative "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$skip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$top"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that is not between 1 and 100"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"401 Unauthorized"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Missing or invalid API key. Returned by the API gateway as"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ \"message\": \"Unauthorized\", \"request_id\": \"d8aafa5b8f3e400b60bea0123dd33317\" }"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"403 Forbidden"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The API key does not have read permissions for this operation. Same body"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"shape as the 401"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"500 Internal Server Error"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Technical error (e.g. database unavailable)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A 400 uses the shared validation envelope, keyed by the offending parameter:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"validationFailures\": {\n    \"$orderby\": [\n      {\n        \"PropertyName\": \"$orderby\",\n        \"ErrorMessage\": \"Ordering by 'tags' is not supported. Supported fields: id, reference, numlinks, status, modifiedon, filetype, createdon (Parameter 'propertyName')\",\n        \"AttemptedValue\": null\n      }\n    ]\n  }\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"validationFailures\": {\n    \"$orderby\": [\n      {\n        \"PropertyName\": \"$orderby\",\n        \"ErrorMessage\": \"Ordering by 'tags' is not supported. Supported fields: id, reference, numlinks, status, modifiedon, filetype, createdon (Parameter 'propertyName')\",\n        \"AttemptedValue\": null\n      }\n    ]\n  }\n}\n"},"children":[]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"$filter","in":"query","schemaId":"schema_12","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OData $filter expression — see the supported fields, operators and functions below"},"children":[]}]}]}]},{"name":"$orderby","in":"query","schemaId":"schema_12","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OData $orderby expression — only the fields listed below are supported"},"children":[]}]}]}]},{"name":"$top","in":"query","schemaId":"schema_13","description":"Maximum number of records to return (default: 100, max: 100)"},{"name":"$skip","in":"query","schemaId":"schema_13","description":"Number of records to skip for pagination (default: 0)"}],"pointer":"/paths/~1images/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-API-KEY","in":"header","schemaId":"schema_12","description":"Tenant's API key (required)","required":true}],"pointer":"/paths/~1images/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/images","servers":[{"url":"https://api2.saleslayer.com/dam","description":"Sales Layer DAM API"}],"parameters":{"path":[],"query":[{"name":"$filter","in":"query","schemaId":"schema_12"},{"name":"$orderby","in":"query","schemaId":"schema_12"},{"name":"$top","in":"query","schemaId":"schema_13"},{"name":"$skip","in":"query","schemaId":"schema_13"}],"querystring":[],"header":[{"name":"X-API-KEY","in":"header","required":true,"schemaId":"schema_12"}],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","500"],"pointer":"/images","href":"images/paths/~1images/get","summary":"Filter Images"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api2.saleslayer.com/dam","description":"Sales Layer DAM API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ImageCollectionRepresentation"}},"schemaId":"components/schemas/ImageCollectionRepresentation"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailureRepresentation"}},"schemaId":"components/schemas/ValidationFailureRepresentation"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedRepresentation"}},"schemaId":"components/schemas/UnauthorizedRepresentation"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenRepresentation"}},"schemaId":"components/schemas/ForbiddenRepresentation"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorRepresentation"}},"schemaId":"components/schemas/ErrorRepresentation"}],"pointer":"/paths/~1images/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ImageCollectionRepresentation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ImageCollectionRepresentation"}}},{"code":"400","schemaId":"components/schemas/ValidationFailureRepresentation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailureRepresentation"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedRepresentation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedRepresentation"}}},{"code":"403","schemaId":"components/schemas/ForbiddenRepresentation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenRepresentation"}}},{"code":"500","schemaId":"components/schemas/ErrorRepresentation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorRepresentation"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/images/paths/~1images/get"}],"panels":[]}]},"httpPath":"/images"},{"label":"Create Image","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/dam-v2.0/images/paths/~1images/post","routeSlug":"/apis/dam-v2.0/images/paths/~1images/post","metadata":{"seo":{"title":"Create Image","description":"Registers a new image from a publicly accessible URL, optionally tagging it. The image is downloaded, validated against the supported formats and size limits, and processed asynchronously in the background."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create Image","isWebhook":false,"pointer":"/paths/~1images/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Image","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Registers a new image from a publicly accessible URL, optionally tagging it. The image is downloaded, validated against the supported formats and size limits, and processed asynchronously in the background."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"images/paths/~1images/post/request/authentication","deepLinkHash":"/images/paths/~1images/post#images/paths/~1images/post/request/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires a valid API key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-API-KEY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"images/paths/~1images/post/request/request-body","deepLinkHash":"/images/paths/~1images/post#images/paths/~1images/post/request/request-body"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request Body"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"url\": \"https://example.com/images/product.jpg\",\n  \"tags\": [\"ecommerce\", \"catalog\", \"summer-2024\"]\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"url\": \"https://example.com/images/product.jpg\",\n  \"tags\": [\"ecommerce\", \"catalog\", \"summer-2024\"]\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"images/paths/~1images/post/request/url-field-(required)","deepLinkHash":"/images/paths/~1images/post#images/paths/~1images/post/request/url-field-(required)"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL Field (Required)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The URL must meet the following requirements:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid URL formats:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be a valid HTTP or HTTPS URL"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be absolute (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://example.com/image.jpg"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Relative URLs are NOT supported (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/images/photo.jpg"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The filename will be automatically extracted from the URL path"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples of valid URLs:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"https://example.com/product.jpg\nhttps://cdn.example.com/images/2024/photo.png\nhttp://assets.example.com/catalog/item_123.gif\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"https://example.com/product.jpg\nhttps://cdn.example.com/images/2024/photo.png\nhttp://assets.example.com/catalog/item_123.gif\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples of invalid URLs:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"/images/product.jpg                    (relative URL)\nexample.com/image.jpg                   (missing protocol)\nftp://server.com/file.jpg              (FTP not supported)\nhttps://example.com/page.html          (not a supported image extension)\nhttps://example.com/product            (no extension to derive the file type from)\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"/images/product.jpg                    (relative URL)\nexample.com/image.jpg                   (missing protocol)\nftp://server.com/file.jpg              (FTP not supported)\nhttps://example.com/page.html          (not a supported image extension)\nhttps://example.com/product            (no extension to derive the file type from)\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL validation rules:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum length: 2048 characters"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The URL must be publicly accessible (no authentication supported)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The host must resolve to a public address. URLs pointing at loopback, private ranges or the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cloud metadata endpoint are rejected"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The URL is probed with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HEAD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request; anything other than a 2xx is rejected"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"images/paths/~1images/post/request/tags-field-(optional)","deepLinkHash":"/images/paths/~1images/post#images/paths/~1images/post/request/tags-field-(optional)"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags Field (Optional)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional array of strings to categorize and organize your images."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rules:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each tag cannot be empty or contain only whitespace"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags are case-sensitive"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags are stored as a single comma-separated string, so a tag containing a comma is read back as"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"several tags. Avoid commas inside a tag"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There is no explicit limit on the number of tags, but the whole comma-separated list must fit in"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"64 KB of storage"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"url\": \"https://example.com/logo.png\",\n  \"tags\": [\"branding\", \"corporate\", \"logo\", \"2024\"]\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"url\": \"https://example.com/logo.png\",\n  \"tags\": [\"branding\", \"corporate\", \"logo\", \"2024\"]\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"images/paths/~1images/post/request/supported-image-formats","deepLinkHash":"/images/paths/~1images/post#images/paths/~1images/post/request/supported-image-formats"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported Image Formats"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The file type is taken from the URL's file extension, and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header returned by the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL is validated independently against the list of accepted image media types:"},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"images/paths/~1images/post/request/fully-supported-formats","deepLinkHash":"/images/paths/~1images/post#images/paths/~1images/post/request/fully-supported-formats"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fully Supported Formats"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Extension"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted Content-Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JPEG"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":".jpg, .jpeg"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"image/jpeg"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standard and progressive JPEG"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PNG"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":".png"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"image/png"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PNG-8, PNG-24, PNG-32 with transparency"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GIF"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":".gif"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"image/gif"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Static and animated GIF"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TIFF"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":".tif, .tiff"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"image/tiff"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"image/x-tiff"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Single and multi-page TIFF"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WebP"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":".webp"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"image/webp"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lossy and lossless compression"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PSD"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":".psd"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"image/vnd.adobe.photoshop"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"image/photoshop"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"image/psd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/octet-stream"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Adobe Photoshop files"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"images/paths/~1images/post/request/content-type-validation","deepLinkHash":"/images/paths/~1images/post#images/paths/~1images/post/request/content-type-validation"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Content-Type Validation"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The URL "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"must return"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Content-Type "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"must be"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" one of the accepted media types listed above"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/octet-stream"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"only accepted for .psd files"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — many servers are misconfigured"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and return this generic type for Photoshop files"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Apart from that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/octet-stream"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" rule, the Content-Type is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cross-checked"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"against the file extension: a URL ending in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".jpg"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that serves "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"image/png"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is accepted, and the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"image is registered with file type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"jpg"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples of valid Content-Type responses:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Content-Type: image/jpeg          → ✅ Accepted\nContent-Type: image/png           → ✅ Accepted\nContent-Type: image/gif           → ✅ Accepted\nContent-Type: application/octet-stream with .psd extension → ✅ Accepted\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Content-Type: image/jpeg          → ✅ Accepted\nContent-Type: image/png           → ✅ Accepted\nContent-Type: image/gif           → ✅ Accepted\nContent-Type: application/octet-stream with .psd extension → ✅ Accepted\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples of invalid Content-Type responses:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Content-Type: text/html           → ❌ Rejected (not an image)\nContent-Type: application/pdf     → ❌ Rejected (not supported)\nContent-Type: application/octet-stream with .jpg extension → ❌ Rejected\n(no Content-Type header)          → ❌ Rejected (missing header)\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Content-Type: text/html           → ❌ Rejected (not an image)\nContent-Type: application/pdf     → ❌ Rejected (not supported)\nContent-Type: application/octet-stream with .jpg extension → ❌ Rejected\n(no Content-Type header)          → ❌ Rejected (missing header)\n"},"children":[]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"images/paths/~1images/post/request/image-size-and-weight-limits","deepLinkHash":"/images/paths/~1images/post#images/paths/~1images/post/request/image-size-and-weight-limits"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Image Size and Weight Limits"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The system automatically validates downloaded images:"},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"images/paths/~1images/post/request/file-size-limits","deepLinkHash":"/images/paths/~1images/post#images/paths/~1images/post/request/file-size-limits"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"File Size Limits"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum file size:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 250 MB (262,144,000 bytes)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Files larger than this limit will be rejected with a validation error"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"images/paths/~1images/post/request/dimension-limits","deepLinkHash":"/images/paths/~1images/post#images/paths/~1images/post/request/dimension-limits"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dimension Limits"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum width:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 30,000 pixels"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum height:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 30,000 pixels"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Images exceeding these dimensions will be rejected"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"images/paths/~1images/post/request/response","deepLinkHash":"/images/paths/~1images/post#images/paths/~1images/post/request/response"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response"},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"images/paths/~1images/post/request/success-response-(201-created)","deepLinkHash":"/images/paths/~1images/post#images/paths/~1images/post/request/success-response-(201-created)"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Success Response (201 Created)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the reference (filename) of the created image, wrapped in the house entity envelope. The"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"reference is the public, tenant-unique key."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"value\": {\n    \"reference\": \"product-123.jpg\"\n  },\n  \"@readLink\": \"https://api2.saleslayer.com/dam/images(product-123.jpg)\",\n  \"@editLink\": \"https://api2.saleslayer.com/dam/images(product-123.jpg)\"\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"value\": {\n    \"reference\": \"product-123.jpg\"\n  },\n  \"@readLink\": \"https://api2.saleslayer.com/dam/images(product-123.jpg)\",\n  \"@editLink\": \"https://api2.saleslayer.com/dam/images(product-123.jpg)\"\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Location"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header points at the new resource, as an absolute URL —"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api2.saleslayer.com/dam/images(product-123.jpg)"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"@readLink"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"@editLink"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" annotations address the created image, matching the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Location"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"so either can be followed to read or modify it. They are only emitted when hypermedia enrichment"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is configured for the deployment; the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Location"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is always present."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The image will be processed asynchronously in the background: it is created with status "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Up"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the worker moves it to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Ok"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Er"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", filling in the dimensions and thumbnail URLs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To check the processing status and retrieve full image details:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"GET /images(product-123.jpg)\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET /images(product-123.jpg)\n"},"children":[]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"images/paths/~1images/post/request/error-responses","deepLinkHash":"/images/paths/~1images/post#images/paths/~1images/post/request/error-responses"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error Responses"},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"images/paths/~1images/post/request/400-bad-request","deepLinkHash":"/images/paths/~1images/post#images/paths/~1images/post/request/400-bad-request"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400 Bad Request"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validation failures are returned in the shared envelope. Service-level messages carry no field"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"context, so they are grouped under a generic "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" key:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"validationFailures\": {\n    \"error\": [\"URL is required\"]\n  }\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"validationFailures\": {\n    \"error\": [\"URL is required\"]\n  }\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The messages you can receive, verbatim:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cause"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Message"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or empty URL"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"URL is required"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL over 2048 characters"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"URL exceeds maximum length of 2048 characters"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not an absolute URL"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"URL is not valid"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scheme other than HTTP/HTTPS"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"URL must use HTTP or HTTPS protocol"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No extension in the URL path"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Could not determine file type from URL. Please ensure the URL contains a filename with an extension."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unsupported extension"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"File extension 'pdf' is not allowed. Allowed extensions: jpg, jpeg, png, gif, tif, tiff, psd, webp"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Host is not publicly routable"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"URL host 'localhost' is not allowed."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL not reachable (non-2xx "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HEAD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"URL is not accessible. HTTP status: 404 Not Found"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"URL does not return a valid Content-Type header"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/octet-stream"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a non-PSD file"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"URL returns generic Content-Type (application/octet-stream) for non-PSD file. Extension detected: jpg"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unsupported Content-Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"URL does not return an image Content-Type. Received: text/html. Allowed types: image/jpeg, image/png, ..."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Empty file"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"The uploaded file is empty"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"File too large"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Image file size (300.00 MB) exceeds maximum allowed size of 250 MB"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dimensions unreadable"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Could not read image dimensions from the uploaded file. Ensure it is a valid image in a supported format."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Image too wide"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Image width (35000px) exceeds maximum allowed width of 30000px"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Image too tall"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Image height (35000px) exceeds maximum allowed height of 30000px"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Empty or whitespace-only tag"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Tags cannot contain empty values"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"images/paths/~1images/post/request/401-unauthorized","deepLinkHash":"/images/paths/~1images/post#images/paths/~1images/post/request/401-unauthorized"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"401 Unauthorized"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-API-KEY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Emitted by the API gateway:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"message\": \"Unauthorized\",\n  \"request_id\": \"d8aafa5b8f3e400b60bea0123dd33317\"\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"message\": \"Unauthorized\",\n  \"request_id\": \"d8aafa5b8f3e400b60bea0123dd33317\"\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Quote "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"request_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when contacting support about a rejected request."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"images/paths/~1images/post/request/403-forbidden","deepLinkHash":"/images/paths/~1images/post#images/paths/~1images/post/request/403-forbidden"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"403 Forbidden"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The API key does not have write permissions for this operation. Same body shape as the 401."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"images/paths/~1images/post/request/409-conflict","deepLinkHash":"/images/paths/~1images/post#images/paths/~1images/post/request/409-conflict"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"409 Conflict"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Two distinct causes, both using the conflict envelope:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An image with the same filename ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") already exists for this tenant:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"error\": \"An image with the filename 'product-123.jpg' already exists\"\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"error\": \"An image with the filename 'product-123.jpg' already exists\"\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The tenant has reached its image-library quota:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"error\": \"Image library limit reached. Current: 5000, Maximum: 5000\"\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"error\": \"Image library limit reached. Current: 5000, Maximum: 5000\"\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Images in status "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dv"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (deleted) do not count towards the quota. Delete unused images to free"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"capacity, or contact Sales Layer to raise the limit."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"images/paths/~1images/post/request/500-internal-server-error","deepLinkHash":"/images/paths/~1images/post#images/paths/~1images/post/request/500-internal-server-error"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"500 Internal Server Error"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Technical errors such as:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Network connectivity issues reaching the source URL, or a download timeout (30s)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Storage service unavailable"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Database errors"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that a source URL that responds with a non-2xx status is a 400, not a 500 — only transport"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"failures and timeouts land here. The body identifies the request for support:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"error\": \"Please contact the administrator of this application by supplying the following code: 0HNF1A2B3C4D5\"\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"error\": \"Please contact the administrator of this application by supplying the following code: 0HNF1A2B3C4D5\"\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"images/paths/~1images/post/request/complete-example","deepLinkHash":"/images/paths/~1images/post#images/paths/~1images/post/request/complete-example"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Complete Example"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"POST /images HTTP/1.1\nHost: api2.saleslayer.com\nX-API-KEY: your-api-key-here\nContent-Type: application/json\n            \n{\n  \"url\": \"https://cdn.example.com/products/summer-2024/product-123.jpg\",\n  \"tags\": [\"ecommerce\", \"summer-collection\", \"featured\", \"new-arrival\"]\n}\n","language":"http"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST /images HTTP/1.1\nHost: api2.saleslayer.com\nX-API-KEY: your-api-key-here\nContent-Type: application/json\n            \n{\n  \"url\": \"https://cdn.example.com/products/summer-2024/product-123.jpg\",\n  \"tags\": [\"ecommerce\", \"summer-collection\", \"featured\", \"new-arrival\"]\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Success Response:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"HTTP/1.1 201 Created\nContent-Type: application/json\nLocation: https://api2.saleslayer.com/dam/images(product-123.jpg)\n            \n{\n  \"value\": {\n    \"reference\": \"product-123.jpg\"\n  }\n}\n","language":"http"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"HTTP/1.1 201 Created\nContent-Type: application/json\nLocation: https://api2.saleslayer.com/dam/images(product-123.jpg)\n            \n{\n  \"value\": {\n    \"reference\": \"product-123.jpg\"\n  }\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Checking the result:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"GET /images(product-123.jpg) HTTP/1.1\nHost: api2.saleslayer.com\nX-API-KEY: your-api-key-here\n","language":"http"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET /images(product-123.jpg) HTTP/1.1\nHost: api2.saleslayer.com\nX-API-KEY: your-api-key-here\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Result after processing:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"value\": {\n    \"id\": 42,\n    \"reference\": \"product-123.jpg\",\n    \"status\": \"Ok\",\n    \"fileType\": \"jpg\",\n    \"width\": 1920,\n    \"height\": 1080,\n    \"sizeInBytes\": 245760,\n    \"numLinks\": 5,\n    \"tags\": [\"ecommerce\", \"summer-collection\", \"featured\", \"new-arrival\"],\n    \"originalUrl\": \"https://cdn.example.com/product-123.jpg\",\n    \"thumbnailUrl\": \"https://cdn.example.com/product-123_TH.jpg\",\n    \"thumbnailMediumUrl\": \"https://cdn.example.com/product-123_THM.jpg\",\n    \"thumbnailPreviewUrl\": \"https://cdn.example.com/product-123_THP.jpg\",\n    \"createdOn\": \"2024-04-02T10:30:00\",\n    \"modifiedOn\": \"2024-04-02T10:30:15\"\n  }\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"value\": {\n    \"id\": 42,\n    \"reference\": \"product-123.jpg\",\n    \"status\": \"Ok\",\n    \"fileType\": \"jpg\",\n    \"width\": 1920,\n    \"height\": 1080,\n    \"sizeInBytes\": 245760,\n    \"numLinks\": 5,\n    \"tags\": [\"ecommerce\", \"summer-collection\", \"featured\", \"new-arrival\"],\n    \"originalUrl\": \"https://cdn.example.com/product-123.jpg\",\n    \"thumbnailUrl\": \"https://cdn.example.com/product-123_TH.jpg\",\n    \"thumbnailMediumUrl\": \"https://cdn.example.com/product-123_THM.jpg\",\n    \"thumbnailPreviewUrl\": \"https://cdn.example.com/product-123_THP.jpg\",\n    \"createdOn\": \"2024-04-02T10:30:00\",\n    \"modifiedOn\": \"2024-04-02T10:30:15\"\n  }\n}\n"},"children":[]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-API-KEY","in":"header","schemaId":"schema_12","description":"Tenant's API key (required)","required":true}],"pointer":"/paths/~1images/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateImageRequest"},"text/json":{"schemaId":"components/schemas/CreateImageRequest"},"application/*+json":{"schemaId":"components/schemas/CreateImageRequest"}},"schemaId":"components/schemas/CreateImageRequest","pointer":"/paths/~1images/post/requestBody","description":"Request containing the image URL and optional tags"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/images","servers":[{"url":"https://api2.saleslayer.com/dam","description":"Sales Layer DAM API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-API-KEY","in":"header","required":true,"schemaId":"schema_12"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateImageRequest"},"text/json":{"schemaId":"components/schemas/CreateImageRequest"},"application/*+json":{"schemaId":"components/schemas/CreateImageRequest"}},"responseCodes":["201","400","401","403","409","500"],"pointer":"/images","href":"images/paths/~1images/post","summary":"Create Image"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api2.saleslayer.com/dam","description":"Sales Layer DAM API"}],"schemaId":"components/schemas/CreateImageRequest","mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateImageRequest"},"text/json":{"schemaId":"components/schemas/CreateImageRequest"},"application/*+json":{"schemaId":"components/schemas/CreateImageRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreatedImageRepresentation"}},"schemaId":"components/schemas/CreatedImageRepresentation"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailureRepresentation"}},"schemaId":"components/schemas/ValidationFailureRepresentation"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedRepresentation"}},"schemaId":"components/schemas/UnauthorizedRepresentation"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenRepresentation"}},"schemaId":"components/schemas/ForbiddenRepresentation"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConflictRepresentation"}},"schemaId":"components/schemas/ConflictRepresentation"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorRepresentation"}},"schemaId":"components/schemas/ErrorRepresentation"}],"pointer":"/paths/~1images/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/CreatedImageRepresentation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreatedImageRepresentation"}}},{"code":"400","schemaId":"components/schemas/ValidationFailureRepresentation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailureRepresentation"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedRepresentation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedRepresentation"}}},{"code":"403","schemaId":"components/schemas/ForbiddenRepresentation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenRepresentation"}}},{"code":"409","schemaId":"components/schemas/ConflictRepresentation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConflictRepresentation"}}},{"code":"500","schemaId":"components/schemas/ErrorRepresentation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorRepresentation"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/images/paths/~1images/post"}],"panels":[]}]},"httpPath":"/images"},{"label":"Get Image","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/dam-v2.0/images/paths/~1images({reference})/get","routeSlug":"/apis/dam-v2.0/images/paths/~1images({reference})/get","metadata":{"seo":{"title":"Get Image","description":"In DAM, images are identified by their filename (reference), which is unique per tenant.Use this endpoint to retrieve a specific image when you already know its filename."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Get Image","isWebhook":false,"pointer":"/paths/~1images({reference})/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Image","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In DAM, images are identified by their filename ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), which is unique per tenant."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this endpoint to retrieve a specific image when you already know its filename."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"images/paths/~1images({reference})/get/request/authentication","deepLinkHash":"/images/paths/~1images({reference})/get#images/paths/~1images({reference})/get/request/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires a valid API key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-API-KEY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"images/paths/~1images({reference})/get/request/example","deepLinkHash":"/images/paths/~1images({reference})/get#images/paths/~1images({reference})/get/request/example"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"GET /images(product-main-front.jpg)\nX-API-KEY: your-api-key-here\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET /images(product-main-front.jpg)\nX-API-KEY: your-api-key-here\n"},"children":[]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"images/paths/~1images({reference})/get/request/response-(200-ok)","deepLinkHash":"/images/paths/~1images({reference})/get#images/paths/~1images({reference})/get/request/response-(200-ok)"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response (200 OK)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The image is wrapped in the house entity envelope — its fields are under "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", never at the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"top level:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"value\": {\n    \"id\": 42,\n    \"reference\": \"product-main-front.jpg\",\n    \"numLinks\": 3,\n    \"status\": \"Ok\",\n    \"modifiedOn\": \"2024-04-05T08:44:33\",\n    \"fileType\": \"jpg\",\n    \"createdOn\": \"2024-04-05T08:44:33\",\n    \"tags\": [\"animales\", \"mascotas\"],\n    \"originalUrl\": \"https://cdn.example.com/product-main-front.jpg\",\n    \"thumbnailUrl\": \"https://cdn.example.com/product-main-front_TH.jpg\",\n    \"thumbnailMediumUrl\": \"https://cdn.example.com/product-main-front_THM.jpg\",\n    \"thumbnailPreviewUrl\": \"https://cdn.example.com/product-main-front_THP.jpg\",\n    \"width\": 800,\n    \"height\": 600,\n    \"sizeInBytes\": 102400\n  },\n  \"@readLink\": \"https://api2.saleslayer.com/dam/images(product-main-front.jpg)\",\n  \"@editLink\": \"https://api2.saleslayer.com/dam/images(product-main-front.jpg)\"\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"value\": {\n    \"id\": 42,\n    \"reference\": \"product-main-front.jpg\",\n    \"numLinks\": 3,\n    \"status\": \"Ok\",\n    \"modifiedOn\": \"2024-04-05T08:44:33\",\n    \"fileType\": \"jpg\",\n    \"createdOn\": \"2024-04-05T08:44:33\",\n    \"tags\": [\"animales\", \"mascotas\"],\n    \"originalUrl\": \"https://cdn.example.com/product-main-front.jpg\",\n    \"thumbnailUrl\": \"https://cdn.example.com/product-main-front_TH.jpg\",\n    \"thumbnailMediumUrl\": \"https://cdn.example.com/product-main-front_THM.jpg\",\n    \"thumbnailPreviewUrl\": \"https://cdn.example.com/product-main-front_THP.jpg\",\n    \"width\": 800,\n    \"height\": 600,\n    \"sizeInBytes\": 102400\n  },\n  \"@readLink\": \"https://api2.saleslayer.com/dam/images(product-main-front.jpg)\",\n  \"@editLink\": \"https://api2.saleslayer.com/dam/images(product-main-front.jpg)\"\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes on the payload:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" tells you whether the image is usable yet — see the status values documented on"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /images"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A freshly created or substituted image is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Up"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" until the worker finishes."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"width"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"height"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sizeInBytes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" come from the stored metadata and are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" until processing"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"has recorded them; the thumbnail URLs are empty until the renditions exist."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is stored as a comma-separated string, so a tag that itself contains a comma comes back"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"split into several tags."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"@readLink"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"@editLink"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are the canonical URL of this image (this request, echoed back), and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"are only emitted when hypermedia enrichment is configured for the deployment."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"images/paths/~1images({reference})/get/request/error-responses","deepLinkHash":"/images/paths/~1images({reference})/get#images/paths/~1images({reference})/get/request/error-responses"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error Responses"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"401 Unauthorized"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Missing or invalid API key. Returned by the API gateway as"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ \"message\": \"Unauthorized\", \"request_id\": \"d8aafa5b8f3e400b60bea0123dd33317\" }"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"403 Forbidden"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The API key does not have read permissions for this operation. Same body"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"shape as the 401"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"404 Not Found"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": No image with the given reference exists for this tenant. The body is the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"message string, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"Image with reference 'missing.jpg' not found\""},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"500 Internal Server Error"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Technical error (e.g. database unavailable)"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"reference","in":"path","schemaId":"schema_12","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Image filename, unique per tenant (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"product-main-front.jpg"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1images({reference})/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-API-KEY","in":"header","schemaId":"schema_12","description":"Tenant's API key (required)","required":true}],"pointer":"/paths/~1images({reference})/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/images({reference})","servers":[{"url":"https://api2.saleslayer.com/dam","description":"Sales Layer DAM API"}],"parameters":{"path":[{"name":"reference","in":"path","required":true,"schemaId":"schema_12"}],"query":[],"querystring":[],"header":[{"name":"X-API-KEY","in":"header","required":true,"schemaId":"schema_12"}],"cookie":[]},"security":[],"responseCodes":["200","401","403","404","500"],"pointer":"/images({reference})","href":"images/paths/~1images({reference})/get","summary":"Get Image"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api2.saleslayer.com/dam","description":"Sales Layer DAM API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ImageEntityRepresentation"}},"schemaId":"components/schemas/ImageEntityRepresentation"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedRepresentation"}},"schemaId":"components/schemas/UnauthorizedRepresentation"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenRepresentation"}},"schemaId":"components/schemas/ForbiddenRepresentation"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_12"}},"schemaId":"schema_12"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorRepresentation"}},"schemaId":"components/schemas/ErrorRepresentation"}],"pointer":"/paths/~1images({reference})/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ImageEntityRepresentation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ImageEntityRepresentation"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedRepresentation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedRepresentation"}}},{"code":"403","schemaId":"components/schemas/ForbiddenRepresentation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenRepresentation"}}},{"code":"404","schemaId":"schema_12","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_12"}}},{"code":"500","schemaId":"components/schemas/ErrorRepresentation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorRepresentation"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/images/paths/~1images({reference})/get"}],"panels":[]}]},"httpPath":"/images({reference})"},{"label":"Patch Image","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/dam-v2.0/images/paths/~1images({reference})/patch","routeSlug":"/apis/dam-v2.0/images/paths/~1images({reference})/patch","metadata":{"seo":{"title":"Patch Image","description":"Partially updates an existing image identified by its filename (reference), which is unique per tenant — substitute its file via a new url and/or replace its tags. At least one of these fields must be supplied."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Patch Image","isWebhook":false,"pointer":"/paths/~1images({reference})/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Patch Image","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Partially updates an existing image identified by its filename ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), which is unique per tenant — substitute its file via a new "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and/or replace its "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". At least one of these fields must be supplied."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The replacement "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can point at a file with any name — the image is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"always stored under its"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"current "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", because that filename is how the rest of the platform points at the image and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a substitution cannot rename it. What the replacement "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cannot"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" change is the image's "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"file type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or the image would end up served under a name that misdescribes it."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"That type is decided by "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the content of the file"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", not by the extension in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": the extension"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is yours to write and any file can be published under any name, so it proves nothing. The extension"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"still has to be one "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /images"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" accepts, but the bytes are what settle the type."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"PATCH /images(product-123.jpg)\n{ \"url\": \"https://cdn.example.com/products/v2/product-123.jpg\" }   OK   same name, JPEG content\n{ \"url\": \"https://cdn.example.com/uploads/a7f3c9e2-render.jpg\" }   OK   any name, JPEG content\n{ \"url\": \"https://cdn.example.com/products/product-123.jpeg\" }    OK   jpg and jpeg are one type\n{ \"url\": \"https://cdn.example.com/products/product-123.png\" }     400  content is a PNG\n{ \"url\": \"https://cdn.example.com/products/product-123.jpg\" }     400  named .jpg, but not a JPEG\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PATCH /images(product-123.jpg)\n{ \"url\": \"https://cdn.example.com/products/v2/product-123.jpg\" }   OK   same name, JPEG content\n{ \"url\": \"https://cdn.example.com/uploads/a7f3c9e2-render.jpg\" }   OK   any name, JPEG content\n{ \"url\": \"https://cdn.example.com/products/product-123.jpeg\" }    OK   jpg and jpeg are one type\n{ \"url\": \"https://cdn.example.com/products/product-123.png\" }     400  content is a PNG\n{ \"url\": \"https://cdn.example.com/products/product-123.jpg\" }     400  named .jpg, but not a JPEG\n"},"children":[]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"images/paths/~1images({reference})/patch/request/changing-an-image's-file-type","deepLinkHash":"/images/paths/~1images({reference})/patch#images/paths/~1images({reference})/patch/request/changing-an-image's-file-type"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Changing an image's file type"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not possible through a substitution, because the filename — and so the extension — is fixed. Do it"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"client-side in three steps:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create the new image"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /images"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with the new file's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Repoint the references"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — use the Catalog API to find every entity (product, variant, category, …)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"that uses the old filename and update it to the new one."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delete the old image"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DELETE /images({old-reference})"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" once nothing references it any more."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"images/paths/~1images({reference})/patch/request/fields","deepLinkHash":"/images/paths/~1images({reference})/patch#images/paths/~1images({reference})/patch/request/fields"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fields"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"url"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (optional): public URL of the new image. Triggers a full image substitution. May be called"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"anything, but must serve an image of the current file type — see above."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"tags"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (optional): array of strings, validated exactly as on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /images"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Absent → tags are not modified, "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"including when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is supplied"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" → all tags are cleared."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[\"a\",\"b\"]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" → tags are replaced with these values."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"images/paths/~1images({reference})/patch/request/valid-combinations","deepLinkHash":"/images/paths/~1images({reference})/patch#images/paths/~1images({reference})/patch/request/valid-combinations"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid combinations"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Body"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Operation"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ \"url\": \"https://.../{any-filename}\" }"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Substitute image — "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"tags are kept"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ \"url\": \"https://.../{any-filename}\", \"tags\": [\"a\"] }"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Substitute image and set tags"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ \"tags\": [\"a\"] }"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update tags only, image file unchanged"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"images/paths/~1images({reference})/patch/request/invalid-combinations","deepLinkHash":"/images/paths/~1images({reference})/patch#images/paths/~1images({reference})/patch/request/invalid-combinations"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid combinations"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Empty body "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" → 400."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" serving content that is not an image of the current file type → 400 (see above)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"images/paths/~1images({reference})/patch/request/response-(204-no-content)","deepLinkHash":"/images/paths/~1images({reference})/patch#images/paths/~1images({reference})/patch/request/response-(204-no-content)"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response (204 No Content)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Success returns no body."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"images/paths/~1images({reference})/patch/request/notes","deepLinkHash":"/images/paths/~1images({reference})/patch#images/paths/~1images({reference})/patch/request/notes"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the image is currently being processed, returns 409."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A substitution resets the image's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Up"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and re-enqueues it for processing, so the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"thumbnails are regenerated. Until the worker finishes, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /images({reference})"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" reports "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Up"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and the rendition URLs still point at the previous file. Poll "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Ok"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Er"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") before"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"treating the new file as live."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A tags-only update does not touch "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and takes effect immediately."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Either way "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"modifiedOn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is refreshed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A substitution does not change the image's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fileType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", so entities referencing it"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"keep working."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"images/paths/~1images({reference})/patch/request/error-responses","deepLinkHash":"/images/paths/~1images({reference})/patch#images/paths/~1images({reference})/patch/request/error-responses"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error Responses"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400 Bad Request"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Invalid request body (e.g., both fields missing), a replacement whose content"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is not an image of the current "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fileType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or any of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" validation failures"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documented on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /images"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (format, accessibility, Content-Type, size, dimensions). Same"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ \"validationFailures\": { \"error\": [...] } }"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" envelope"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"401 Unauthorized"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Missing or invalid API key. Returned by the API gateway as"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ \"message\": \"Unauthorized\", \"request_id\": \"d8aafa5b8f3e400b60bea0123dd33317\" }"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"403 Forbidden"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The API key does not have write permissions for this operation. Same body"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"shape as the 401"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"404 Not Found"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": No image with the given reference exists for this tenant. The body is the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"message string, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"Image with reference 'missing.jpg' not found\""},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"409 Conflict"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The image is currently being processed and cannot be modified —"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ \"error\": \"Image 'product-123.jpg' is currently being processed and cannot be modified\" }"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"500 Internal Server Error"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Technical error (network failure fetching the replacement file,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"storage or database unavailable). The already-uploaded replacement object is cleaned up, so the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"image is left on its previous file"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"reference","in":"path","schemaId":"schema_12","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Image filename (reference), unique per tenant (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"product-main-front.jpg"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1images({reference})/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-API-KEY","in":"header","schemaId":"schema_12","description":"Tenant's API key (required)","required":true}],"pointer":"/paths/~1images({reference})/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PatchImageRequest"},"text/json":{"schemaId":"components/schemas/PatchImageRequest"},"application/*+json":{"schemaId":"components/schemas/PatchImageRequest"}},"schemaId":"components/schemas/PatchImageRequest","pointer":"/paths/~1images({reference})/patch/requestBody","description":"Fields to update. At least one of 'url' or 'tags' must be present."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/images({reference})","servers":[{"url":"https://api2.saleslayer.com/dam","description":"Sales Layer DAM API"}],"parameters":{"path":[{"name":"reference","in":"path","required":true,"schemaId":"schema_12"}],"query":[],"querystring":[],"header":[{"name":"X-API-KEY","in":"header","required":true,"schemaId":"schema_12"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/PatchImageRequest"},"text/json":{"schemaId":"components/schemas/PatchImageRequest"},"application/*+json":{"schemaId":"components/schemas/PatchImageRequest"}},"responseCodes":["204","400","401","403","404","409","500"],"pointer":"/images({reference})","href":"images/paths/~1images({reference})/patch","summary":"Patch Image"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api2.saleslayer.com/dam","description":"Sales Layer DAM API"}],"schemaId":"components/schemas/PatchImageRequest","mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PatchImageRequest"},"text/json":{"schemaId":"components/schemas/PatchImageRequest"},"application/*+json":{"schemaId":"components/schemas/PatchImageRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailureRepresentation"}},"schemaId":"components/schemas/ValidationFailureRepresentation"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedRepresentation"}},"schemaId":"components/schemas/UnauthorizedRepresentation"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenRepresentation"}},"schemaId":"components/schemas/ForbiddenRepresentation"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_12"}},"schemaId":"schema_12"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConflictRepresentation"}},"schemaId":"components/schemas/ConflictRepresentation"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorRepresentation"}},"schemaId":"components/schemas/ErrorRepresentation"}],"pointer":"/paths/~1images({reference})/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ValidationFailureRepresentation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailureRepresentation"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedRepresentation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedRepresentation"}}},{"code":"403","schemaId":"components/schemas/ForbiddenRepresentation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenRepresentation"}}},{"code":"404","schemaId":"schema_12","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_12"}}},{"code":"409","schemaId":"components/schemas/ConflictRepresentation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConflictRepresentation"}}},{"code":"500","schemaId":"components/schemas/ErrorRepresentation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorRepresentation"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/images/paths/~1images({reference})/patch"}],"panels":[]}]},"httpPath":"/images({reference})"},{"label":"Delete Image","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/dam-v2.0/images/paths/~1images({reference})/delete","routeSlug":"/apis/dam-v2.0/images/paths/~1images({reference})/delete","metadata":{"seo":{"title":"Delete Image","description":"Deletes an image by its filename (reference), which is unique per tenant."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Delete Image","isWebhook":false,"pointer":"/paths/~1images({reference})/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Image","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes an image by its filename ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), which is unique per tenant."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"images/paths/~1images({reference})/delete/request/authentication","deepLinkHash":"/images/paths/~1images({reference})/delete#images/paths/~1images({reference})/delete/request/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires a valid API key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-API-KEY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"images/paths/~1images({reference})/delete/request/example","deepLinkHash":"/images/paths/~1images({reference})/delete#images/paths/~1images({reference})/delete/request/example"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"DELETE /images(product-main-front.jpg)\nX-API-KEY: your-api-key-here\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"DELETE /images(product-main-front.jpg)\nX-API-KEY: your-api-key-here\n"},"children":[]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"images/paths/~1images({reference})/delete/request/response-(204-no-content)","deepLinkHash":"/images/paths/~1images({reference})/delete#images/paths/~1images({reference})/delete/request/response-(204-no-content)"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response (204 No Content)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Success returns no body."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"images/paths/~1images({reference})/delete/request/important:-deletion-does-not-cascade","deepLinkHash":"/images/paths/~1images({reference})/delete#images/paths/~1images({reference})/delete/request/important:-deletion-does-not-cascade"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Important: deletion does not cascade"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The image record is removed outright. The deletion is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" propagated to the entities that use"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the image — check "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"numLinks"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on the image first ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /images({reference})"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"): if it is greater than"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"zero, the products, variants and categories still referencing the filename will be left pointing at"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"an image that no longer exists. Repoint them via the Catalog API before deleting."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"images/paths/~1images({reference})/delete/request/error-responses","deepLinkHash":"/images/paths/~1images({reference})/delete#images/paths/~1images({reference})/delete/request/error-responses"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error Responses"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"401 Unauthorized"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Missing or invalid API key. Returned by the API gateway as"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ \"message\": \"Unauthorized\", \"request_id\": \"d8aafa5b8f3e400b60bea0123dd33317\" }"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"403 Forbidden"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The API key does not have write permissions for this operation. Same body"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"shape as the 401"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"404 Not Found"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": No image with the given reference exists for this tenant. The body is the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"message string, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"Image with reference 'missing.jpg' not found\""},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"409 Conflict"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Image is currently being processed and cannot be deleted —"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ \"error\": \"Image 'product-123.jpg' is currently being processed and cannot be deleted\" }"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"500 Internal Server Error"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Technical error (e.g. database unavailable)"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"reference","in":"path","schemaId":"schema_12","description":"Image filename (reference), unique per tenant","required":true}],"pointer":"/paths/~1images({reference})/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-API-KEY","in":"header","schemaId":"schema_12","description":"Tenant's API key (required)","required":true}],"pointer":"/paths/~1images({reference})/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/images({reference})","servers":[{"url":"https://api2.saleslayer.com/dam","description":"Sales Layer DAM API"}],"parameters":{"path":[{"name":"reference","in":"path","required":true,"schemaId":"schema_12"}],"query":[],"querystring":[],"header":[{"name":"X-API-KEY","in":"header","required":true,"schemaId":"schema_12"}],"cookie":[]},"security":[],"responseCodes":["204","401","403","404","409","500"],"pointer":"/images({reference})","href":"images/paths/~1images({reference})/delete","summary":"Delete Image"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api2.saleslayer.com/dam","description":"Sales Layer DAM API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedRepresentation"}},"schemaId":"components/schemas/UnauthorizedRepresentation"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenRepresentation"}},"schemaId":"components/schemas/ForbiddenRepresentation"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_12"}},"schemaId":"schema_12"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConflictRepresentation"}},"schemaId":"components/schemas/ConflictRepresentation"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorRepresentation"}},"schemaId":"components/schemas/ErrorRepresentation"}],"pointer":"/paths/~1images({reference})/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/UnauthorizedRepresentation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedRepresentation"}}},{"code":"403","schemaId":"components/schemas/ForbiddenRepresentation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenRepresentation"}}},{"code":"404","schemaId":"schema_12","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_12"}}},{"code":"409","schemaId":"components/schemas/ConflictRepresentation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConflictRepresentation"}}},{"code":"500","schemaId":"components/schemas/ErrorRepresentation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorRepresentation"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/images/paths/~1images({reference})/delete"}],"panels":[]}]},"httpPath":"/images({reference})"}],"content":{"contentType":"group","meta":{"name":"Images"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Images","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/images","summary":"Filter Images","prefix":{"name":"get","color":"get"},"badges":[],"link":"/images/paths/~1images/get","deprecated":false},{"title":"/images","summary":"Create Image","prefix":{"name":"post","color":"post"},"badges":[],"link":"/images/paths/~1images/post","deprecated":false},{"title":"/images({reference})","summary":"Get Image","prefix":{"name":"get","color":"get"},"badges":[],"link":"/images/paths/~1images({reference})/get","deprecated":false},{"title":"/images({reference})","summary":"Patch Image","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/images/paths/~1images({reference})/patch","deprecated":false},{"title":"/images({reference})","summary":"Delete Image","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/images/paths/~1images({reference})/delete","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/FileDto":{"id":"components/schemas/FileDto","kind":"json-schema","title":"FileDto","data":{"type":"object","properties":{"reference":{"type":"string","description":"The file's filename, unique per tenant. This is the public key used to address the file and the\r\nvalue entities use to reference it.","nullable":true},"numLinks":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of entities (products, variants, categories, …) currently using this file."},"children":[]}]}]}],"format":"int32"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Processing status: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Vd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (void), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Up"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (uploading/updating), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Ok"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (ready to use),"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Re"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (reprocessing), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Er"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (processing failed) or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dv"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (deleted). Only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Ok"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"guarantees the stored file is usable."},"children":[]}]}]}],"nullable":true},"modifiedOn":{"type":"string","description":"When the file was last modified.","format":"date-time"},"fileType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"File extension of the file, without the dot (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pdf"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"csv"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Derived from the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"filename, not from the served Content-Type."},"children":[]}]}]}],"nullable":true},"createdOn":{"type":"string","description":"When the file was created. Null for files predating creation-date tracking.","format":"date-time","nullable":true},"tags":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags assigned to the file. Stored as a comma-separated string, so a tag containing a comma is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"read back as several tags. Not usable in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$filter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$orderby"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true},"url":{"type":"string","description":"URL of the stored file. Empty until processing has run.","nullable":true},"sizeInBytes":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Size of the file in bytes; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" until processing has recorded it. Not usable in"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$filter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$orderby"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"int64"}},"additionalProperties":false,"description":"A file asset."}},"components/schemas/FileCollectionRepresentation":{"id":"components/schemas/FileCollectionRepresentation","kind":"json-schema","title":"FileCollectionRepresentation","data":{"type":"object","properties":{"value":{"type":"array","items":{"$ref":"#/components/schemas/FileDto"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The files in this page, at most "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$top"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default and maximum 100)."},"children":[]}]}]}],"nullable":true},"@count":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total number of files matching the filter, ignoring "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$top"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$skip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"int64","nullable":true},"@readLink":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Canonical URL of this collection — this request, echoed back. Present only when hypermedia"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"enrichment is enabled."},"children":[]}]}]}],"nullable":true},"@nextLink":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL of the next page, omitted on the last page. Present only when hypermedia enrichment is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"enabled; otherwise page forward by incrementing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$skip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" yourself."},"children":[]}]}]}],"nullable":true}},"additionalProperties":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A page of files wrapped in the house collection envelope: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ value, @count }"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"components/schemas/ValidationFailureRepresentation":{"id":"components/schemas/ValidationFailureRepresentation","kind":"json-schema","title":"ValidationFailureRepresentation","data":{"type":"object","properties":{"validationFailures":{"type":"object","additionalProperties":{"type":"array","items":{}},"nullable":true}},"additionalProperties":false}},"components/schemas/UnauthorizedRepresentation":{"id":"components/schemas/UnauthorizedRepresentation","kind":"json-schema","title":"UnauthorizedRepresentation","data":{"type":"object","properties":{"message":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error description, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Unauthorized"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true},"request_id":{"type":"string","description":"Gateway request identifier, to quote when contacting support.","nullable":true}},"additionalProperties":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Represents a 401 Unauthorized response returned when the API key is missing or invalid."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOTE: this body is produced by the API gateway, which owns API-key authentication — DAM itself never"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"validates the key, so a request that reaches this service has already been authenticated. Documented"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here because it is what callers of the public API actually receive."},"children":[]}]}]}]}},"components/schemas/ForbiddenRepresentation":{"id":"components/schemas/ForbiddenRepresentation","kind":"json-schema","title":"ForbiddenRepresentation","data":{"type":"object","properties":{"message":{"type":"string","nullable":true},"request_id":{"type":"string","nullable":true}},"additionalProperties":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Represents a 403 Forbidden response returned when the API key does not have write permissions for"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"this operation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOTE: this body is produced by the API gateway, which owns API-key authentication — DAM itself never"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"validates the key, and the 403 it can emit for an unauthorised "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AppResponse"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has an empty body"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Sl.Common.App.Adapters.Api.Rest.ActionResults.Forbidden"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Kept as the documented shape"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for the gateway-generated response."},"children":[]}]}]}]}},"components/schemas/ErrorRepresentation":{"id":"components/schemas/ErrorRepresentation","kind":"json-schema","title":"ErrorRepresentation","data":{"type":"object","properties":{"error":{"type":"string","nullable":true,"readOnly":true},"details":{"nullable":true,"readOnly":true}},"additionalProperties":false}},"components/schemas/CreateFileRequest":{"id":"components/schemas/CreateFileRequest","kind":"json-schema","title":"CreateFileRequest","data":{"type":"object","properties":{"url":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Publicly accessible HTTP or HTTPS URL of the file to import. Required. Must be absolute and end"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in a supported extension (pdf, doc, docx, txt, xls, xlsx, csv, rtf, ppt, pptx, zip, rar, tar,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"mpeg, mpg, avi, mov, tif, tiff, ai, eps, psd, x3d, sup, ldt, ies, dwg, obj, webp); the file's"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the filename taken from the URL path. Maximum 2048 characters."},"children":[]}]}]}],"nullable":true},"tags":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional tags to associate with the file, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[\"datasheets\", \"catalog\", \"2024\"]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Tags are"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"case-sensitive and cannot be empty or whitespace. Avoid commas inside a tag — tags are stored as a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"comma-separated string and would be read back split."},"children":[]}]}]}],"nullable":true}},"additionalProperties":false,"description":"Request to create a new File entity."}},"components/schemas/CreateFileResponse":{"id":"components/schemas/CreateFileResponse","kind":"json-schema","title":"CreateFileResponse","data":{"type":"object","properties":{"reference":{"type":"string","description":"The file's filename, unique per tenant. This is the public key used to address the file.","nullable":true}},"additionalProperties":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The reference of a newly created file. Retrieve the full file with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /files({reference})"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Unlike an image, a file is usable as soon as it is created — nothing"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"processes it afterwards — so it starts, and stays, in status "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Ok"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"components/schemas/CreatedFileRepresentation":{"id":"components/schemas/CreatedFileRepresentation","kind":"json-schema","title":"CreatedFileRepresentation","data":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/CreateFileResponse"},"@readLink":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Canonical URL of the created file, the same resource the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Location"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header names."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present only when hypermedia enrichment is enabled."},"children":[]}]}]}],"nullable":true},"@editLink":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL to modify the created file, identical to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"@readLink"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Present only when hypermedia"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"enrichment is enabled."},"children":[]}]}]}],"nullable":true}},"additionalProperties":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The reference of a newly created file, wrapped in the house entity envelope: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ value }"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"components/schemas/ConflictRepresentation":{"id":"components/schemas/ConflictRepresentation","kind":"json-schema","title":"ConflictRepresentation","data":{"type":"object","properties":{"error":{"type":"string","nullable":true}},"additionalProperties":false}},"components/schemas/FileEntityRepresentation":{"id":"components/schemas/FileEntityRepresentation","kind":"json-schema","title":"FileEntityRepresentation","data":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/FileDto"},"@readLink":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Canonical URL of this file — this request, echoed back. Present only when hypermedia enrichment"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is enabled."},"children":[]}]}]}],"nullable":true},"@editLink":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL to modify this file, identical to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"@readLink"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Present only when hypermedia enrichment"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is enabled."},"children":[]}]}]}],"nullable":true}},"additionalProperties":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A single file wrapped in the house entity envelope: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ value }"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"components/schemas/PatchFileRequest":{"id":"components/schemas/PatchFileRequest","kind":"json-schema","title":"PatchFileRequest","data":{"type":"object","properties":{"reference":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Taken from the URL path, not from the request body — any value sent in the body is ignored."},"children":[]}]}]}],"nullable":true},"url":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Publicly accessible URL of the replacement file, which triggers a full substitution. Optional,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"but at least one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be supplied. Validated exactly as on create."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The replacement may be called anything at its own address — it is stored under the file's current"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sl.Apps.Dam.Application.Files.PatchFile.PatchFileRequest.Reference — but it must be a file of the same file type."},"children":[]}]}]}],"nullable":true},"tags":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags to set on the file. Optional. Omit to leave the tags untouched, send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to clear them,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or send values to replace them."},"children":[]}]}]}],"nullable":true}},"additionalProperties":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request to partially update a File entity, identified by its reference (filename)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The file is located by Sl.Apps.Dam.Application.Files.PatchFile.PatchFileRequest.Reference, which is the public, tenant-unique key"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(the numeric id is internal only). Supported body fields:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sl.Apps.Dam.Application.Files.PatchFile.PatchFileRequest.Url  → full file substitution."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sl.Apps.Dam.Application.Files.PatchFile.PatchFileRequest.Tags → update tags."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"At least one body field must be present."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags semantics:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"null  → field absent: tags are NOT modified, whatever else the request asks for."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[]    → clear: tags are set to empty."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[...] → replace: tags are replaced with these values."},"children":[]}]}]}]}]}},"components/schemas/ImageDto":{"id":"components/schemas/ImageDto","kind":"json-schema","title":"ImageDto","data":{"type":"object","properties":{"id":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal numeric identifier. Not stable as a public key — address images by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"int32"},"reference":{"type":"string","description":"The image's filename, unique per tenant. This is the public key used to address the image and the\r\nvalue entities use to reference it.","nullable":true},"numLinks":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of entities (products, variants, categories, …) currently using this image."},"children":[]}]}]}],"format":"int32"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Processing status: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Vd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (void), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Up"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (uploading/updating), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Ok"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (ready to use),"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Re"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (reprocessing), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Er"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (processing failed) or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dv"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (deleted). Only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Ok"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"guarantees the renditions exist."},"children":[]}]}]}],"nullable":true},"modifiedOn":{"type":"string","description":"When the image was last modified.","format":"date-time"},"fileType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"File extension of the image, without the dot (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"jpg"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"png"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Derived from the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"filename, not from the served Content-Type."},"children":[]}]}]}],"nullable":true},"createdOn":{"type":"string","description":"When the image was created. Null for images predating creation-date tracking.","format":"date-time","nullable":true},"tags":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags assigned to the image. Stored as a comma-separated string, so a tag containing a comma is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"read back as several tags. Not usable in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$filter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$orderby"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true},"originalUrl":{"type":"string","description":"URL of the original, full-size image. Empty until processing has run.","nullable":true},"thumbnailUrl":{"type":"string","description":"URL of the small thumbnail rendition. Empty until processing has generated it.","nullable":true},"thumbnailMediumUrl":{"type":"string","description":"URL of the medium thumbnail rendition. Empty until processing has generated it.","nullable":true},"thumbnailPreviewUrl":{"type":"string","description":"URL of the preview thumbnail rendition. Empty until processing has generated it.","nullable":true},"width":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Width of the image in pixels; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" until processing has recorded it. Not usable in"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$filter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$orderby"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"int32"},"height":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Height of the image in pixels; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" until processing has recorded it. Not usable in"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$filter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$orderby"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"int32"},"sizeInBytes":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Size of the image file in bytes; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" until processing has recorded it. Not usable in"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$filter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$orderby"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"int64"}},"additionalProperties":false,"description":"An image asset."}},"components/schemas/ImageCollectionRepresentation":{"id":"components/schemas/ImageCollectionRepresentation","kind":"json-schema","title":"ImageCollectionRepresentation","data":{"type":"object","properties":{"value":{"type":"array","items":{"$ref":"#/components/schemas/ImageDto"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The images in this page, at most "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$top"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default and maximum 100)."},"children":[]}]}]}],"nullable":true},"@count":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total number of images matching the filter, ignoring "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$top"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$skip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"int64","nullable":true},"@readLink":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Canonical URL of this collection — this request, echoed back. Present only when hypermedia"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"enrichment is enabled."},"children":[]}]}]}],"nullable":true},"@nextLink":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL of the next page, omitted on the last page. Present only when hypermedia enrichment is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"enabled; otherwise page forward by incrementing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$skip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" yourself."},"children":[]}]}]}],"nullable":true}},"additionalProperties":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A page of images wrapped in the house collection envelope: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ value, @count }"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"components/schemas/CreateImageRequest":{"id":"components/schemas/CreateImageRequest","kind":"json-schema","title":"CreateImageRequest","data":{"type":"object","properties":{"url":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Publicly accessible HTTP or HTTPS URL of the image to import. Required. Must be absolute and end"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in a supported extension (jpg, jpeg, png, gif, tif, tiff, psd, webp); the image's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is the filename taken from the URL path. Maximum 2048 characters."},"children":[]}]}]}],"nullable":true},"tags":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional tags to associate with the image, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[\"product\", \"catalog\", \"2024\"]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Tags are"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"case-sensitive and cannot be empty or whitespace. Avoid commas inside a tag — tags are stored as a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"comma-separated string and would be read back split."},"children":[]}]}]}],"nullable":true}},"additionalProperties":false,"description":"Request to create a new Image entity."}},"components/schemas/CreateImageResponse":{"id":"components/schemas/CreateImageResponse","kind":"json-schema","title":"CreateImageResponse","data":{"type":"object","properties":{"reference":{"type":"string","description":"The image's filename, unique per tenant. This is the public key used to address the image.","nullable":true}},"additionalProperties":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The reference of a newly created image. Retrieve the full image with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /images({reference})"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; processing runs asynchronously, so the image starts in status"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Up"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and moves to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Ok"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Er"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"components/schemas/CreatedImageRepresentation":{"id":"components/schemas/CreatedImageRepresentation","kind":"json-schema","title":"CreatedImageRepresentation","data":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/CreateImageResponse"},"@readLink":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Canonical URL of the created image, the same resource the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Location"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header names."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present only when hypermedia enrichment is enabled."},"children":[]}]}]}],"nullable":true},"@editLink":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL to modify the created image, identical to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"@readLink"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Present only when hypermedia"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"enrichment is enabled."},"children":[]}]}]}],"nullable":true}},"additionalProperties":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The reference of a newly created image, wrapped in the house entity envelope: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ value }"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"components/schemas/ImageEntityRepresentation":{"id":"components/schemas/ImageEntityRepresentation","kind":"json-schema","title":"ImageEntityRepresentation","data":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/ImageDto"},"@readLink":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Canonical URL of this image — this request, echoed back. Present only when hypermedia enrichment"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is enabled."},"children":[]}]}]}],"nullable":true},"@editLink":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL to modify this image, identical to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"@readLink"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Present only when hypermedia enrichment"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is enabled."},"children":[]}]}]}],"nullable":true}},"additionalProperties":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A single image wrapped in the house entity envelope: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ value }"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"components/schemas/PatchImageRequest":{"id":"components/schemas/PatchImageRequest","kind":"json-schema","title":"PatchImageRequest","data":{"type":"object","properties":{"reference":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Taken from the URL path, not from the request body — any value sent in the body is ignored."},"children":[]}]}]}],"nullable":true},"url":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Publicly accessible URL of the replacement image, which triggers a full substitution. Optional,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"but at least one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be supplied. Validated exactly as on create."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The replacement may be called anything at its own address — it is stored under the image's"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"current Sl.Apps.Dam.Application.Images.PatchImage.PatchImageRequest.Reference — but it must be an image of the same file type."},"children":[]}]}]}],"nullable":true},"tags":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags to set on the image. Optional. Omit to leave the tags untouched, send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to clear them,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or send values to replace them — including when the image itself is substituted via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"which never touches the tags on its own."},"children":[]}]}]}],"nullable":true}},"additionalProperties":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request to partially update an Image entity, identified by its reference (filename)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The image is located by Sl.Apps.Dam.Application.Images.PatchImage.PatchImageRequest.Reference, which is the public, tenant-unique key"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(images are not addressed by their numeric id). Supported body fields:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sl.Apps.Dam.Application.Images.PatchImage.PatchImageRequest.Url  → full image substitution."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sl.Apps.Dam.Application.Images.PatchImage.PatchImageRequest.Tags → update tags."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"At least one body field must be present."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags semantics:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"null  → field absent: tags are NOT modified."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[]    → clear: tags are set to empty."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[...] → replace: tags are replaced with these values."},"children":[]}]}]}]}]}},"schema_12":{"kind":"json-schema","data":{"type":"string"},"id":"schema_12"},"schema_13":{"kind":"json-schema","data":{"type":"integer","format":"int64"},"id":"schema_13"}},"exampleStore":{},"securitySchemeStore":{"ApiKey":{"id":"ApiKey","type":"apiKey","description":"Tenant API key. Required on every request.","in":"header","paramName":"X-API-KEY"}},"servers":[{"url":"https://api2.saleslayer.com/dam","description":"Sales Layer DAM API"}]},"options":{"hideSidebar":true,"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/apis/dam-v2.0.json?download"},{"url":"/_bundle/apis/dam-v2.0.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Sales Layer DAM REST API","description":"The Sales Layer DAM REST API lets external systems work with digital assets managed by Sales Layer: images and non-image files (documents, spreadsheets, archives, and more).\n\nUse this reference when you need to create, list, filter, retrieve, update, or delete image or file records — including registering assets from public URLs, replacing their source content or tags, and removing assets that are no longer required by your catalog workflows.\n\nDAM operations are designed for integrations that keep media libraries, product imagery, product documentation, commerce platforms, supplier portals, and other business systems aligned with Sales Layer. For implementation guidance, review the authentication, pagination, rate limiting, and error handling guides before calling the endpoints below.\n"}},"baseSlug":"/apis/dam-v2.0","routesMapping":{}}