{"items":[{"type":"link","label":"DAM Context API","link":"/dam/context-api","routeSlug":"/dam/context-api","content":{"contentType":"overview","meta":{"name":"DAM Context API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"index.json","url":"/_bundle/dam/context-api/index.json?download"},{"kind":"download","label":"index.yaml","url":"/_bundle/dam/context-api/index.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"License","titleTranslationKey":"info.license","label":"closed source","url":"https://www.sitecore.com"}]},{"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://{server}","variables":{"server":{"default":"your-server"}}}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"DAM Context API (v1.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":"Use the DAM Context API to discover the searchable asset context (taxonomies, fields, data sources, relations, renditions, and usage-rights dimensions) derived from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"M.Asset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" definition. The keys and operators returned by this endpoint  describe the filters, sorting, and response expansions supported by the DAM Assets API."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning","name":"Early Access"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API is currently available as Early Access."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The API and its documentation may be updated as we continue to develop the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"capability and incorporate feedback. Endpoints, schemas, and behavior"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"may change before General Availability."},"children":[]}]}]}]}]}],"sectionId":"/dam/context-api"}],"sectionId":"/dam/context-api"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/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":"To use this API, you need:"},"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":"The hostname of your Content Hub server, without "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or a trailing slash. You can get this from your Content Hub administrator. Use it as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"server"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" variable in the request URL."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An access token, sent with every request as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain the token using your client's supported "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.sitecore.com/ch/en/developers/cloud-dev/oauth-tokens.html#grant-flows"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication flow"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}],"sectionId":"/dam/context-api/section/authentication"}]}]}},{"type":"link","label":"Authentication","link":"/dam/context-api/section/authentication","routeSlug":"/dam/context-api/section/authentication","content":null},{"type":"group","label":"DAM Context","link":"/dam/context-api/dam-context","routeSlug":"/dam/context-api/dam-context","items":[{"label":"Retrieve searchable DAM asset context","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dam/context-api/dam-context/getdamassetcontext","routeSlug":"/dam/context-api/dam-context/getdamassetcontext","metadata":{"seo":{"title":"Retrieve searchable DAM asset context","description":"Retrieves the taxonomies, fields, data sources, relations, renditions, and usage-rights dimensions available for DAM asset search and response expansion, derived from the M.Asset definition, localized to the requested culture. This context covers asset members only."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDamAssetContext","name":"Retrieve searchable DAM asset context","isWebhook":false,"pointer":"/paths/~1api~1v1~1dam~1assets~1context/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve searchable DAM asset context","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":"Retrieves the taxonomies, fields, data sources, relations, renditions, and usage-rights dimensions available for DAM asset search and response expansion, derived from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"M.Asset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" definition, localized to the requested culture. This context covers asset members only."},"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":"include"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter accepts the following parameters:"},"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":"taxonomies"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fields"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dataSources"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"relations"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"renditions"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"usageRights"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter is omitted, the response contains taxonomy  metadata and instance capabilities. Request additional sections explicitly,  for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include=taxonomies,fields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". To retrieve all sections, specify  "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taxonomies,fields,dataSources,relations,renditions,usageRights"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":".  Request only the sections you need to limit response size. Before  filtering assets by usage rights, check that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"capabilities.usageRights"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"  is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and request the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"usageRights"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section to discover supported dimensions."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{server}/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"culture","in":"query","schemaId":"schema_963","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Culture/language code used to localize labels, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"en-US"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Accepts a single culture code. Defaults to the caller's preferred culture, falling back to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"en-US"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"include","in":"query","schemaId":"schema_964","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Section names to return, sent as one comma-separated value, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include=taxonomies,fields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Omitted or empty returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taxonomies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only; name every section to receive all of them. An unknown name returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400 UNKNOWN_INCLUDE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with the offending value and the valid names in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalidParams"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":["taxonomies","fields"]}],"pointer":"/paths/~1api~1v1~1dam~1assets~1context/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/dam/assets/context","servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"parameters":{"path":[],"query":[{"name":"culture","in":"query","example":"en-US","schemaId":"schema_963"},{"name":"include","in":"query","example":["taxonomies","fields"],"schemaId":"schema_964","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{server}/oauth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","429","500"],"pointer":"/api/v1/dam/assets/context","href":"dam-context/getdamassetcontext","openApiOperationId":"getDamAssetContext","summary":"Retrieve searchable DAM asset context"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DamAssetContextResponse"}},"schemaId":"components/schemas/DamAssetContextResponse"},{"code":"400","description":"Facade validation failures use ErrorResponse. Framework model-state failures use a parameter-to-messages dictionary.","mediaType":"application/problem+json","mediaTypes":["application/problem+json","application/json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ErrorResponse"},"application/json":{"schemaId":"components/schemas/ModelStateValidationErrors"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Handled by existing authentication before endpoint access checks. This endpoint does not define or change the authentication error body."},{"code":"403","description":"Access denied after successful authentication. Never returned for a malformed request.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limited by the platform throttling middleware when throttling is enabled for the environment. The body is a plain-text message, not an ErrorResponse. Retry after the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"text/plain","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"schema_965"}},"schemaId":"schema_965","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"headerSchemaId":"schema_966"},{"code":"500","description":"Internal error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1api~1v1~1dam~1assets~1context/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DamAssetContextResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DamAssetContextResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/problem+json","application/json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ErrorResponse"},"application/json":{"schemaId":"components/schemas/ModelStateValidationErrors"}}},{"code":"401"},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"429","schemaId":"schema_965","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"schema_965"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/dam-context/getdamassetcontext"}],"panels":[]}]},"httpPath":"/api/v1/dam/assets/context"}],"content":{"contentType":"group","meta":{"name":"DAM Context"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"DAM Context","showPageActions":true},{"nodeType":"markdoc","content":"Discover the searchable asset context."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/dam/assets/context","summary":"Retrieve searchable DAM asset context","prefix":{"name":"get","color":"get"},"badges":[],"link":"/dam-context/getdamassetcontext","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/ModelStateValidationErrors":{"id":"components/schemas/ModelStateValidationErrors","kind":"json-schema","title":"ModelStateValidationErrors","data":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"description":"Framework validation errors keyed by request parameter path."}},"components/schemas/ErrorResponse":{"id":"components/schemas/ErrorResponse","kind":"json-schema","title":"ErrorResponse","data":{"type":"object","required":["status","code"],"description":"Problem Details error response with Sitecore extension members.  code and category appear at the top level, not inside an error object.","properties":{"type":{"type":"string","format":"uri","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generic RFC 7231 status-code reference, shared across codes. Never branch on this; branch on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"title":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stable per "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"status":{"type":"integer"},"detail":{"type":"string","description":"Occurrence-specific explanation."},"instance":{"type":"string","description":"The request path that produced this occurrence."},"code":{"type":"string","pattern":"^[A-Z][A-Z0-9_]*$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stable identifier. Never reworded or renumbered once shipped. Context validation returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INVALID_VALUE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for an invalid culture or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UNKNOWN_INCLUDE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for an unknown section. Unhandled endpoint failures return "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INTERNAL_ERROR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Authentication, authorization, and platform throttling errors are handled separately."},"children":[]}]}]}]},"category":{"type":"string","enum":["auth","precondition","not_found","ambiguous","validation","conflict","policy","unsupported"],"description":"Omitted for timeout, rate-limit, dependency, or internal failures."},"requiredNextStep":{"type":"object","required":["operationId","method","href","reason"],"description":"The single best recovery call, if one exists.","properties":{"operationId":{"type":"string"},"method":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE"]},"href":{"type":"string"},"reason":{"type":"string"}}},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"description":"Parameter name to human-readable messages."},"invalidParams":{"type":"array","items":{"type":"object","properties":{"parameter":{"type":"string"},"value":{"type":"string","nullable":true,"description":"The offending value as received, when applicable."},"reason":{"type":"string","enum":["no_match","ambiguous","wrong_taxonomy","unparseable","operator_not_supported"]},"candidates":{"type":"array","items":{"type":"string"}}}}},"traceId":{"type":"string"}}}},"components/schemas/DamAssetContextResponse":{"id":"components/schemas/DamAssetContextResponse","kind":"json-schema","title":"DamAssetContextResponse","data":{"type":"object","required":["include"],"properties":{"culture":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The culture used to localize the returned context, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"en-US"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"include":{"type":"array","items":{"type":"string","enum":["taxonomies","fields","dataSources","relations","renditions","usageRights"]},"description":"Contains the effective section selection. Defaults to taxonomies when  the request's include parameter is omitted."},"taxonomies":{"type":"array","items":{"$ref":"#/components/schemas/DamAssetContextTaxonomy"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Taxonomies available for filtering or expanding assets. Absent when not selected by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"fields":{"type":"array","items":{"$ref":"#/components/schemas/DamAssetContextField"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fields available for filtering or expanding assets. Absent when not selected by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"dataSources":{"type":"array","items":{"$ref":"#/components/schemas/DamAssetContextDataSource"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data sources available for filtering or expanding assets. Absent when not selected by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"relations":{"type":"array","items":{"$ref":"#/components/schemas/DamAssetContextRelation"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Relations available for filtering or expanding assets. Absent when not selected by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"renditions":{"type":"array","items":{"$ref":"#/components/schemas/DamAssetContextRendition"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Renditions available for asset response expansion. Absent when not selected by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"usageRights":{"$ref":"#/components/schemas/DamAssetContextUsageRights"},"capabilities":{"$ref":"#/components/schemas/DamAssetContextCapabilities"}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Searchable DAM asset context derived from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"M.Asset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" definition."},"children":[]}]}]}]}},"components/schemas/DamAssetContextTaxonomy":{"id":"components/schemas/DamAssetContextTaxonomy","kind":"json-schema","title":"DamAssetContextTaxonomy","data":{"type":"object","properties":{"key":{"type":"string","description":"Canonical taxonomy key used by search filters, sorting, and response expansion."},"definitionName":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The taxonomy's entity definition name, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"M.PCM.Market"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"label":{"type":"string","description":"The taxonomy's label in the requested culture."},"multiValue":{"type":"boolean","description":"Whether the taxonomy allows multiple values."},"filterable":{"type":"boolean","description":"Whether this taxonomy key can be used in filters and exclusions."},"hierarchical":{"type":"boolean","description":"Whether the taxonomy is hierarchical."},"sortable":{"type":"boolean","description":"Whether this key can be used as a sort field."},"operators":{"type":"array","items":{"type":"string"},"description":"Operators supported for this taxonomy key."}}}},"components/schemas/DamAssetContextField":{"id":"components/schemas/DamAssetContextField","kind":"json-schema","title":"DamAssetContextField","data":{"type":"object","properties":{"key":{"type":"string","description":"Canonical field key used by search filters, sorting, and response expansion."},"label":{"type":"string","description":"The field's label in the requested culture."},"dataType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The field's data type, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"string"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"integer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"long"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"datetime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"multiValue":{"type":"boolean","description":"Whether the field allows multiple values."},"multiLanguage":{"type":"boolean","description":"Whether the field is multilingual."},"filterable":{"type":"boolean","description":"Whether this field key can be used in filters and exclusions."},"sortable":{"type":"boolean","description":"Whether this key can be used as a sort field."},"operators":{"type":"array","items":{"type":"string"},"description":"Operators supported for this field key."}}}},"components/schemas/DamAssetContextDataSource":{"id":"components/schemas/DamAssetContextDataSource","kind":"json-schema","title":"DamAssetContextDataSource","data":{"type":"object","description":"Option-list data source metadata; this entry has no display label.","properties":{"key":{"type":"string","description":"Canonical data-source key used by response expansion and, when filterable, search filters."},"filterable":{"type":"boolean","description":"Whether this data-source key can be used in filters and exclusions."},"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The data source's name. Retrieve its values with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /api/datasources/{name}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"operationId: getDataSourceByName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"operators":{"type":"array","items":{"type":"string"},"description":"Operators supported for this data-source key."},"sortable":{"type":"boolean","description":"Whether this data-source key can be used as a sort field. Option-list string keys are not sortable."}}}},"components/schemas/DamAssetContextRelation":{"id":"components/schemas/DamAssetContextRelation","kind":"json-schema","title":"DamAssetContextRelation","data":{"type":"object","properties":{"key":{"type":"string","description":"Canonical relation key used by response expansion and, when filterable, search filters."},"definitionName":{"type":"string","nullable":true,"description":"The related entity definition name."},"label":{"type":"string","description":"The relation's label in the requested culture."},"multiValue":{"type":"boolean","description":"Whether the relation allows multiple values."},"filterable":{"type":"boolean","description":"Whether this relation key can be used in filters and exclusions."},"selfRelation":{"type":"boolean","description":"Whether the relation targets the same entity definition as the asset."},"sortable":{"type":"boolean","description":"Whether this key can be used as a sort field."},"operators":{"type":"array","items":{"type":"string"},"description":"Operators supported for this relation key."}}}},"components/schemas/DamAssetContextRendition":{"id":"components/schemas/DamAssetContextRendition","kind":"json-schema","title":"DamAssetContextRendition","data":{"type":"object","description":"Rendition metadata has no display label, sortability, or filter operators.","properties":{"key":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Canonical rendition key used for response expansion, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Preview"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Thumbnail"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"filterable":{"type":"boolean","description":"Whether this rendition key can be used in filters and exclusions. Renditions are not filterable."},"mediaTypes":{"type":"array","items":{"type":"string"},"description":"Asset-media entity identifiers associated with this rendition."}}}},"components/schemas/DamAssetContextUsageRights":{"id":"components/schemas/DamAssetContextUsageRights","kind":"json-schema","title":"DamAssetContextUsageRights","data":{"type":"object","required":["constraints"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage-rights dimensions a scenario can constrain. Absent when not selected by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Selected but unavailable returns an empty "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"constraints"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array. Dimensions omitted from a scenario are not checked. When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"capabilities.usageRights"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is true, a scenario can filter by dates only even if no dimensions are advertised."},"children":[]}]}]}],"properties":{"constraints":{"type":"array","items":{"$ref":"#/components/schemas/DamAssetContextUsageRightsConstraint"},"description":"Configured taxonomy dimensions visible to the caller. Empty when usage rights are unavailable or no dimension is advertised."}}}},"components/schemas/DamAssetContextUsageRightsConstraint":{"id":"components/schemas/DamAssetContextUsageRightsConstraint","kind":"json-schema","title":"DamAssetContextUsageRightsConstraint","data":{"type":"object","properties":{"key":{"type":"string","description":"Configured usage-rights key used to submit values for this dimension."},"definitionName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Taxonomy definition name. Pass it as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"listTaxonomyValues"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and submit the returned identifiers."},"children":[]}]}]}]},"label":{"type":"string","description":"The dimension's label in the requested culture. Display metadata only; not a filter value."},"hierarchical":{"type":"boolean","description":"Whether the taxonomy is hierarchical."},"operators":{"type":"array","items":{"type":"string","enum":["allOf","anyOf"]},"description":"Operators supported for this dimension."}}}},"components/schemas/DamAssetContextCapabilities":{"id":"components/schemas/DamAssetContextCapabilities","kind":"json-schema","title":"DamAssetContextCapabilities","data":{"type":"object","properties":{"visualSearch":{"type":"boolean","description":"Whether visual search is enabled for this instance."},"imageTagging":{"type":"boolean","description":"Whether image tagging is enabled for this instance."},"usageRights":{"type":"boolean","description":"Whether usage-rights scenarios are available for this instance. Always returned."}}}},"schema_963":{"kind":"json-schema","data":{"type":"string","example":"en-US"},"id":"schema_963"},"schema_964":{"kind":"json-schema","data":{"type":"array","default":["taxonomies"],"items":{"type":"string","enum":["taxonomies","fields","dataSources","relations","renditions","usageRights"]}},"id":"schema_964"},"schema_965":{"kind":"json-schema","data":{"type":"string"},"id":"schema_965"},"schema_966":{"kind":"json-schema","data":{"type":"object","properties":{"Retry-After":{"type":"integer","description":"Seconds to wait before retrying."}}},"id":"schema_966"}},"exampleStore":{},"securitySchemeStore":{"OAuth2":{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{server}/oauth/token","scopes":{}}}}},"servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"specType":"openapi"},"options":{"hideInfoMetadata":true,"sanitize":true,"sortRequiredPropsFirst":true,"corsProxyUrl":"https://cors.redoc.ly","mockServer":{"off":true,"position":"off"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/dam/context-api/index.json?download"},{"url":"/_bundle/dam/context-api/index.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"DAM Context API","description":"Use the DAM Context API to discover the searchable asset context (taxonomies, fields, data sources, relations, renditions, and usage-rights dimensions) derived from the `M.Asset` definition. The keys and operators returned by this endpoint  describe the filters, sorting, and response expansions supported by the DAM Assets API.\n{% admonition type=\"warning\" name=\"Early Access\" %}\n    This API is currently available as Early Access. \n    The API and its documentation may be updated as we continue to develop the \n    capability and incorporate feedback. Endpoints, schemas, and behavior \n    may change before General Availability.\n{% /admonition %}\n## Authentication\n\nTo use this API, you need:\n\n- The hostname of your Content Hub server, without `https://` or a trailing slash. You can get this from your Content Hub administrator. Use it as the `server` variable in the request URL.\n- An access token, sent with every request as `Authorization: Bearer <token>`. Obtain the token using your client's supported [authentication flow](https://doc.sitecore.com/ch/en/developers/cloud-dev/oauth-tokens.html#grant-flows).\n","product":["SitecoreAI","Content Hub"],"category":"Discover DAM assets"}},"baseSlug":"/dam/context-api","routesMapping":{}}