{"items":[{"type":"link","label":"Dash API","link":"/dash/openapi","routeSlug":"/dash/openapi","content":{"contentType":"overview","meta":{"name":"Dash API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"openapi.json","url":"/_bundle/dash/@v2/openapi.json?download"},{"kind":"download","label":"openapi.yaml","url":"/_bundle/dash/@v2/openapi.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"URL","titleTranslationKey":"info.contact.url","label":"https://dash.app","url":"https://dash.app"},{"kind":"email","title":"E-mail","titleTranslationKey":"info.contact.name","email":"help@dash.app","label":"help@dash.app","withCopyButton":true,"copyContent":"help@dash.app"}]},{"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":[{"description":"Production","url":"https://api-v2.dash.app"},{"description":"Staging","url":"https://api-v2.dashstaging.app"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Dash API (2.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[]}],"sectionId":"/dash/openapi"}],"sectionId":"/dash/openapi"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/introduction"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Introduction"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Dash API follows the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/Representational_state_transfer"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REST"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" standard and uses common "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" headers, methods and response codes."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request and response bodies are all in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.json.org/json-en.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format except for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PUT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" requests of binary file data when upload files."},"children":[]}]}]}]}],"sectionId":"/dash/openapi/section/introduction"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/operations-jobs-and-batches"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Operations, Jobs and Batches"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the standard "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PUT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DELETE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" methods cannot adequately describe an operation on a resource the operation may itself  be treated as a resource and the endpoint URLs will reflect this accordingly."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example making a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/asset-uploads"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returns an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/postassetupload"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetUpload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource which describes the URL(s) the client should "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PUT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the binary data to upload a file to an asset."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If an operation is unlikely to complete via a synchronous REST call, or asynchronous behaviour is simply preferable, job resource endpoints may provided for the operation."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Created job resources can then be periodically polled to Get the status of the operation."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Such endpoints can be expected to contain a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"job"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" qualifier. e.g "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/asset-download-jobs"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/asset-download-jobs/{id}"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All job resources can be expected to conform to a polymorphic job structure with common properties such as "},"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":"progress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and type specific properties such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dateCompleted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for successfully completed jobs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If an operation can be applied to multiple resources an endpoint may provided to create a batch resource for the operation."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Such endpoints can be expected to contain a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"batch"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" qualifier."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As batch operations almost always need to be asynchronous you can expect to see both qualifiers in the endpoint URL e.g "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/asset-download-batch-jobs"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/asset-download-batch-jobs/{id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"sectionId":"/dash/openapi/section/operations-jobs-and-batches"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/authorisation"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorisation"},"children":[]}]}]}]}],"sectionId":"/dash/openapi/section/authorisation"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/authorisation/get-a-short-lived-bearer-token-for-testing"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get a short-lived bearer token for testing"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You should read the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Authorisation/OAuth2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OAuth2 section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if you want to set up programmatic API access to Dash. However, if you just want to try out an API endpoint, or want to "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/custom/putcustomintegrationsettings"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"request your client ID and secret"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (required for OAuth2 below), you can get a short-lived bearer token:"},"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":"Log in to your Dash account as normal"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Open the browser developer tools (CMD + OPTION + I on Mac or CTRL + SHIFT + I on Windows)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Click the \"Application\" tab"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Under \"Storage\" in the left panel, expand \"local storage\""},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Click on the URL of your Dash site"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Copy the \"value\" for the access_token from the right-hand panel (be sure to select the whole thing - double click to edit, select all then copy)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This token can be used to try out an endpoint directly from these docs. Just click \"Try it...\" in the right-hand panel and enter your token in the \"Auth\" tab."},"children":[]}]}]}]}],"sectionId":"/dash/openapi/section/authorisation/get-a-short-lived-bearer-token-for-testing"}],"sectionId":"/dash/openapi/section/authorisation/get-a-short-lived-bearer-token-for-testing"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/authorisation/oauth2"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OAuth2"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dash uses OAuth 2.0 for authorisation. A good overview of OAuth 2.0 can be found "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://auth0.com/docs/protocols/protocol-oauth2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"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":"Endpoints:"},"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":"https://login.dash.app/authorize"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://login.dash.app/oauth/token"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scopes to note:"},"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":"subdomain"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": this should be set to the subdomain of the Dash the user is trying to access e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain:my-account"},"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":"offline_access"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": the standard OAuth 2.0 scope to use to obtain a refresh token"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Audience:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An query parameter of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"audience=https://assetplatform.io"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be provided to the https://login.dash.app/authorize endpoint"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To obtain your client ID and secret, follow the steps above to "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Authorisation/Get-a-short-lived-bearer-token-for-testing"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"get a temporary bearer token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and use this to "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/custom/putcustomintegrationsettings"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"create custom integration settings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The response you receive from the custom integrations settings endpoint will include your client ID and secret."},"children":[]}]}]}]}],"sectionId":"/dash/openapi/section/authorisation/oauth2"}],"sectionId":"/dash/openapi/section/authorisation/oauth2"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/authorisation/authorization-code-flow"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization Code Flow"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To begin the flow, send your user in a browser to to"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://login.dash.app/authorize?response_type=code&audience=https://assetplatform.io&client_id={YOUR_CLIENT_ID}&redirect_uri={YOUR_REDIRECT}&scope=offline_access%20subdomain:{YOUR_SUBDOMAIN}"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once the user successfully authenticates, they will be redirected to your "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"redirect_uri"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with the Authorization Code provided in a query parameter."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Now that you have an Authorization Code, you must exchange it for your tokens via the https://login.dash.app/oauth/token endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl --request POST \\\n  --url 'https://login.dash.app/oauth/token' \\\n  --header 'content-type: application/x-www-form-urlencoded' \\\n  --data grant_type=authorization_code \\\n  --data 'client_id={YOUR_CLIENT_ID}' \\\n  --data 'client_secret={YOUR_CLIENT_SECRET}' \\\n  --data 'code={CODE_FROM_PREVIOUS_STEP}' \\\n  --data 'redirect_uri={YOUR_REDIRECT}'\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl --request POST \\\n  --url 'https://login.dash.app/oauth/token' \\\n  --header 'content-type: application/x-www-form-urlencoded' \\\n  --data grant_type=authorization_code \\\n  --data 'client_id={YOUR_CLIENT_ID}' \\\n  --data 'client_secret={YOUR_CLIENT_SECRET}' \\\n  --data 'code={CODE_FROM_PREVIOUS_STEP}' \\\n  --data 'redirect_uri={YOUR_REDIRECT}'\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A more detailed description of the Authorization Code Flow can be found "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://auth0.com/docs/get-started/authentication-and-authorization-flow/add-login-auth-code-flow"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]}]}]}]}],"sectionId":"/dash/openapi/section/authorisation/authorization-code-flow"}],"sectionId":"/dash/openapi/section/authorisation/authorization-code-flow"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/authorisation/authentication-without-user-interaction"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication Without User Interaction"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Due to security concerns, neither OAuth grant types "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Client Credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Password"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are supported by the Dash API."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you require an automated script to call the Dash API, we recommend going through the Authorization Code Flow described above once, specifying the offline_access scope to get a refresh token along with your access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your script can store and use this refresh token to call https://login.dash.app/oauth/token and get a new access token when the current one expires."},"children":[]}]}]}]}],"sectionId":"/dash/openapi/section/authorisation/authentication-without-user-interaction"}],"sectionId":"/dash/openapi/section/authorisation/authentication-without-user-interaction"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/authorisation/current-user-details"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Current User Details"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Bearer Token is a standard "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://jwt.io/introduction"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" token so can be useful to decode in some cases."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sub"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field of the Bearer Token can be used in cases where you need access to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User.id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the current user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"e.g. When making an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/postassetsearch"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetSearch"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STAGED_BY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" criterion to find all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources staged by the current user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alternatively the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/users/getcurrentuser"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET Current User"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint contains properties for the current user to avoid needing to decode the Bearer Token."},"children":[]}]}]}]}],"sectionId":"/dash/openapi/section/authorisation/current-user-details"}],"sectionId":"/dash/openapi/section/authorisation/current-user-details"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/permitted-actions"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permitted Actions"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In most responses from the Dash API you will find a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"permittedActions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property alongside a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"result"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property which contains the resource."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is to provide context for operations the current user is permitted to perform on that resource."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If an expected permitted action is not included in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"permittedActions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property then the current user does not have permission to perform the action."},"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":"link","inline":true,"attributes":{"href":"/dash/openapi/users/getcurrentuser"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET Current User"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint houses permitted actions which are not associated with a specific API resource instance."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"e.g. If the current user has permission to create new "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources then the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/users/getcurrentuser"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET Current User"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"permittedActions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property will contain the permitted action "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ASSETS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" : "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CREATE_ASSETS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"sectionId":"/dash/openapi/section/permitted-actions"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/common-use-cases"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common Use Cases"},"children":[]}]}]}]}],"sectionId":"/dash/openapi/section/common-use-cases"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/common-use-cases/getting-fields-and-field-options-for-asset-metadata"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Getting fields and field options for asset metadata"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset.metadata"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" consists of a map of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"String"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"String[]"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The keys for map are "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" IDs. Full details, including the field name, can be got via the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/fields/getfield"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET Field"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint or the full list of fields for an account can be retrieved via the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/fields/getfields"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The map values are a list of plain text values if "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field.hasFixedOptions = false"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or a list of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" IDs if "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field.hasFixedOptions = true"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Where "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field.hasFixedOptions = true"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" details, including the field option name, can be got via the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/field-options/getfieldoption"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET Field Option"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Where "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field.hierarchical = true"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the complete branch of the tree will be returned and can be constructed via the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption.parent"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property."},"children":[]}]}]}]}],"sectionId":"/dash/openapi/section/common-use-cases/getting-fields-and-field-options-for-asset-metadata"}],"sectionId":"/dash/openapi/section/common-use-cases/getting-fields-and-field-options-for-asset-metadata"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/common-use-cases/getting-the-full-schema-of-fields-and-field-options"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Getting the full schema of fields and field options"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The full list of fields for an account can be retrieved via the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/fields/getfields"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Where "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field.hasFixedOptions = true"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/field-options/postfieldoptionsearch"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST Field Option Searches"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint can be used to get the available options."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Where "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field.hierarchical = true"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" you should start with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PARENT_ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FIELD_IS_EMPTY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query to get the top level options and then "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PARENT_ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FIELD_EQUALS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" queries to get each sub-level."},"children":[]}]}]}]}],"sectionId":"/dash/openapi/section/common-use-cases/getting-the-full-schema-of-fields-and-field-options"}],"sectionId":"/dash/openapi/section/common-use-cases/getting-the-full-schema-of-fields-and-field-options"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/common-use-cases/folders"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Folders"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A Folder in Dash is simply a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", for the built-in Folders "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". To determine the ID of the Folders "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Folder-Settings"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Folder Settings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint. Once you have this ID, Folders behave the same as any other "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field"},"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":"For getting the folder tree see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Common-Use-Cases/Getting-fields-and-field-options-for-asset-metadata"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Getting fields and field options for asset metadata"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Common-Use-Cases/Getting-the-full-schema-of-fields-and-field-options"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Getting the full schema of fields and field options"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For getting assets in folders see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/postassetsearch"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetSearch"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For getting assets in no folders see the "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search for field is empty"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" example in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/postassetsearch"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST Asset Searches"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}],"sectionId":"/dash/openapi/section/common-use-cases/folders"}],"sectionId":"/dash/openapi/section/common-use-cases/folders"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/common-use-cases/creating-a-new-asset"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creating a new asset"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Assets are the main resources in Dash. An asset consists of a file, some fixed properties (such as the date the asset was added to Dash) and custom metadata."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To create new assets and upload files:"},"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":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/postassetanduploadbatchjob"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an Asset and Upload batch job"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wait for the job to complete by checking the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/postassetupload/operation/getAssetAndUploadBatchJob"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET Asset and upload batch job"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The completed job includes an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/postassetupload"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetUpload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources in the job's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"result"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property. For each file you want to upload:"},"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":"Make PUT requests to upload your file part with the byte ranges specified to the URLs in the corresponding "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetUploadPart"},"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":"Get the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"etag"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property from the response of each PUT request and use them to complete the upload via the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/postassetuploadCompletion"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST Asset Upload Completion"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The assets will be created with a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Asset-Lifecycle"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"lifecycle status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STAGED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/postassetlifecycletransitionbatchjob"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST Asset lifecycle transition batch job"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint if you'd like to change the state of the assets (e.g. to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING_APPROVAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}]}],"sectionId":"/dash/openapi/section/common-use-cases/creating-a-new-asset"}],"sectionId":"/dash/openapi/section/common-use-cases/creating-a-new-asset"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/common-use-cases/uploading-a-new-file-for-an-asset"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Uploading a new file for an asset"},"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":"Create an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/postassetupload"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetUpload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" via the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/postassetupload"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST Asset Upload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Make PUT requests to upload your file part with the byte ranges specified to the URLs in the corresponding "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetUploadPart"},"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":"Get the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"etag"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property from the response of each PUT request and use them to complete the upload via the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/postassetuploadCompletion"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST Asset Upload Completion"},"children":[]}]}]}]}]}]}],"sectionId":"/dash/openapi/section/common-use-cases/uploading-a-new-file-for-an-asset"}],"sectionId":"/dash/openapi/section/common-use-cases/uploading-a-new-file-for-an-asset"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/common-use-cases/getting-asset-file-versions"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Getting asset file versions"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The current "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/getassetfiles"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetFile"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is returned in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource via the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset.currentFile"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property."},"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":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/getassetfiles"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET Asset Files"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint can be used to get all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/getassetfiles"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetFile"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources for an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]}]}]}]}],"sectionId":"/dash/openapi/section/common-use-cases/getting-asset-file-versions"}],"sectionId":"/dash/openapi/section/common-use-cases/getting-asset-file-versions"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/common-use-cases/editing-asset-metadata"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Editing asset metadata"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Edit the contents of one or more "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset.metadata"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" map properties via the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/postassetmetadataeditbatchjob"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST Asset Metadata Edit Batch Job"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint and check on the progress and status of the edit via the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/getassetmetadataeditbatchjob"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET Asset Metadata Edit Batch Job"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}],"sectionId":"/dash/openapi/section/common-use-cases/editing-asset-metadata"}],"sectionId":"/dash/openapi/section/common-use-cases/editing-asset-metadata"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/common-use-cases/getting-user-collections"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Getting user collections"},"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":"Get the current user ID from the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Authorisation/Current-User-Details"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"current user details"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ASSOCIATED_WITH_USER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" criterion of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/collections/postcollectionsearch"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST Collection Search"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint to get all collections a user has access to."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To get the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources in each collection see the "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All assets in a collection"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search within assets in a collection"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" examples  in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/postassetsearch"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST Asset Searches"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint for how to specify the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Collections"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Collection.id"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COLLECTIONS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" : "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FIELD_EQUALS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" criterion."},"children":[]}]}]}]}]}],"sectionId":"/dash/openapi/section/common-use-cases/getting-user-collections"}],"sectionId":"/dash/openapi/section/common-use-cases/getting-user-collections"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/common-use-cases/search-by-file-extension"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search by file extension"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search by file extension"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search by multiple file extensions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" example in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/postassetsearch"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST Asset Searches"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint"},"children":[]}]}]}]}],"sectionId":"/dash/openapi/section/common-use-cases/search-by-file-extension"}],"sectionId":"/dash/openapi/section/common-use-cases/search-by-file-extension"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/common-use-cases/searching-for-changed-assets"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Searching for changed assets"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following date properties exist on an asset and can be supplied as FIXED field criteria in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/postassetsearch"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST Asset Searches"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint"},"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":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset.lifecycleStatus.dateStaged"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" : The datetime the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was created but not yet live. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DATE_STAGED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in search criteria."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset.lifecycleStatus.datePendingApproval"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" : The datetime the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was set for approval (if it was). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DATE_PENDING_APPROVAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in search criteria."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset.lifecycleStatus.dateLive"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" : The datetime the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was put live. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DATE_LIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in search criteria."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset.currentAssetFile.dateAdded"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" : The datetime the latest "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/getassetfiles"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetFile"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was added. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DATE_LAST_ASSET_FILE_ADDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in search criteria."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset.dateLastModified"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" : The datetime the "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"any"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" change was made to an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This includes all of the above and any change to custom metadata "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DATE_LAST_MODIFIED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in search criteria."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There is currently no way to determine if only custom metadata has changes."},"children":[]}]}]}]}],"sectionId":"/dash/openapi/section/common-use-cases/searching-for-changed-assets"}],"sectionId":"/dash/openapi/section/common-use-cases/searching-for-changed-assets"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/migration-from-v1"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Migration from V1"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Several breaking changes have been introduced in the switch from V1 to V2, which are all the result of three changes."},"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 domain is changing from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"brightdash.app"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dash.app"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":".  All URLs used to access the API, including for authorisation, should be updated to the new domain."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The concept of \"asset staging status\" has been renamed to \"asset lifecycle\" with the introduction of the bin, which adds another state for assets that isn't just about the staging workflow.  This second change manifests in the changing of the StagingWorkflowTransitionBatchJob to the LifecycleTransitionBatchJob, a refactoring of the asset model to bring the \"date added\" and \"added by\" fields together with other lifecycle information, and the renaming of the \"date added\" and \"added by\" fields to the more specific \"date live\" and \"staged by\"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Asset batch jobs used to only support carrying out operations on assets by a search criterion.  This has been extended to also allow performing operations by id, so the \"criterion\" field has changed to a \"selector\" field which supports objects of either type."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The term "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Attribute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has been renamed to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" throughout, to mirror the change of terminology within the Dash frontend."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All these changes are described in more specific detail below."},"children":[]}]}]}]}],"sectionId":"/dash/openapi/section/migration-from-v1"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/migration-from-v1/domain"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain"},"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":"Domain has changed from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"brightdash.app"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dash.app"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" throughout the API."},"children":[]}]}]}]}]}],"sectionId":"/dash/openapi/section/migration-from-v1/domain"}],"sectionId":"/dash/openapi/section/migration-from-v1/domain"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/migration-from-v1/asset-staging-workflow"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Asset Staging Workflow"},"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 path of this endpoint has changed from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"asset-staging-workflow-transition-batch-jobs"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"asset-lifecycle-transition-batch-jobs"},"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":"criterion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the POST body has become "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"selector"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and the criterion now needs to be wrapped in the following "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{\"type\": \"BY_CRITERION\", \"criterion\": {...}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}],"sectionId":"/dash/openapi/section/migration-from-v1/asset-staging-workflow"}],"sectionId":"/dash/openapi/section/migration-from-v1/asset-staging-workflow"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/migration-from-v1/asset-searches"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Asset Searches"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For both scroll and paged searches:"},"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 following "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"criterion.field.fieldName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sorts.field.fieldName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values have been renamed:"},"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":"DATE_ADDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" -> "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DATE_LIVE"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ADDED_BY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" -> "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STAGED_BY"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","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":"stagingStatus"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"addedBy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dateAdded"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields have been removed from the response. This data can now be found in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lifecycleStatus"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]}]}],"sectionId":"/dash/openapi/section/migration-from-v1/asset-searches"}],"sectionId":"/dash/openapi/section/migration-from-v1/asset-searches"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/migration-from-v1/asset-deletion"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Asset Deletion"},"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":"criterion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the POST body has become "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"selector"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and the criterion now needs to be wrapped in the following "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{\"type\": \"BY_CRITERION\", \"criterion\": {...}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}],"sectionId":"/dash/openapi/section/migration-from-v1/asset-deletion"}],"sectionId":"/dash/openapi/section/migration-from-v1/asset-deletion"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/migration-from-v1/asset-metadata-edit"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Asset Metadata Edit"},"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":"criterion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the POST body has become "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"selector"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and the criterion now needs to be wrapped in the following "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{\"type\": \"BY_CRITERION\", \"criterion\": {...}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}],"sectionId":"/dash/openapi/section/migration-from-v1/asset-metadata-edit"}],"sectionId":"/dash/openapi/section/migration-from-v1/asset-metadata-edit"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/migration-from-v1/search-filters"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search Filters"},"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 value returned from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"searchField"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field of search filter results of type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HARD_CODED_FREE_OPTION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" have changed from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DATE_ADDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DATE_LIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":".  This isn't really a breaking change as the specification says this field could return any string, but it feels worth mentioning."},"children":[]}]}]}]}]}],"sectionId":"/dash/openapi/section/migration-from-v1/search-filters"}],"sectionId":"/dash/openapi/section/migration-from-v1/search-filters"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/migration-from-v1/saved-search"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Saved Search"},"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 following "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"criterion.field.fieldName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sorts.field.fieldName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values have been renamed for both POSTing and GETting SavedSearches:"},"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":"DATE_ADDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" -> "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DATE_LIVE"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ADDED_BY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" -> "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STAGED_BY"},"children":[]}]}]}]}]}]}]}],"sectionId":"/dash/openapi/section/migration-from-v1/saved-search"}],"sectionId":"/dash/openapi/section/migration-from-v1/saved-search"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/migration-from-v1/attributesfields"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attributes/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":"The string "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Attribute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has been replaced with the string "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" throughout.  This includes e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AttributeOption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" being renamed to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":".  A simple find and replace should be enough to migrate."},"children":[]}]}]}]}]}],"sectionId":"/dash/openapi/section/migration-from-v1/attributesfields"}],"sectionId":"/dash/openapi/section/migration-from-v1/attributesfields"}]}]}},{"type":"link","label":"Introduction","link":"/dash/openapi/section/introduction","routeSlug":"/dash/openapi/section/introduction","content":null},{"type":"link","label":"Operations, Jobs and Batches","link":"/dash/openapi/section/operations-jobs-and-batches","routeSlug":"/dash/openapi/section/operations-jobs-and-batches","content":null},{"type":"group","label":"Authorisation","link":"/dash/openapi/section/authorisation","routeSlug":"/dash/openapi/section/authorisation","items":[{"type":"link","label":"Get a short-lived bearer token for testing","link":"/dash/openapi/section/authorisation/get-a-short-lived-bearer-token-for-testing","routeSlug":"/dash/openapi/section/authorisation/get-a-short-lived-bearer-token-for-testing","content":null},{"type":"link","label":"OAuth2","link":"/dash/openapi/section/authorisation/oauth2","routeSlug":"/dash/openapi/section/authorisation/oauth2","content":null},{"type":"link","label":"Authorization Code Flow","link":"/dash/openapi/section/authorisation/authorization-code-flow","routeSlug":"/dash/openapi/section/authorisation/authorization-code-flow","content":null},{"type":"link","label":"Authentication Without User Interaction","link":"/dash/openapi/section/authorisation/authentication-without-user-interaction","routeSlug":"/dash/openapi/section/authorisation/authentication-without-user-interaction","content":null},{"type":"link","label":"Current User Details","link":"/dash/openapi/section/authorisation/current-user-details","routeSlug":"/dash/openapi/section/authorisation/current-user-details","content":null}],"content":null},{"type":"link","label":"Permitted Actions","link":"/dash/openapi/section/permitted-actions","routeSlug":"/dash/openapi/section/permitted-actions","content":null},{"type":"group","label":"Common Use Cases","link":"/dash/openapi/section/common-use-cases","routeSlug":"/dash/openapi/section/common-use-cases","items":[{"type":"link","label":"Getting fields and field options for asset metadata","link":"/dash/openapi/section/common-use-cases/getting-fields-and-field-options-for-asset-metadata","routeSlug":"/dash/openapi/section/common-use-cases/getting-fields-and-field-options-for-asset-metadata","content":null},{"type":"link","label":"Getting the full schema of fields and field options","link":"/dash/openapi/section/common-use-cases/getting-the-full-schema-of-fields-and-field-options","routeSlug":"/dash/openapi/section/common-use-cases/getting-the-full-schema-of-fields-and-field-options","content":null},{"type":"link","label":"Folders","link":"/dash/openapi/section/common-use-cases/folders","routeSlug":"/dash/openapi/section/common-use-cases/folders","content":null},{"type":"link","label":"Creating a new asset","link":"/dash/openapi/section/common-use-cases/creating-a-new-asset","routeSlug":"/dash/openapi/section/common-use-cases/creating-a-new-asset","content":null},{"type":"link","label":"Uploading a new file for an asset","link":"/dash/openapi/section/common-use-cases/uploading-a-new-file-for-an-asset","routeSlug":"/dash/openapi/section/common-use-cases/uploading-a-new-file-for-an-asset","content":null},{"type":"link","label":"Getting asset file versions","link":"/dash/openapi/section/common-use-cases/getting-asset-file-versions","routeSlug":"/dash/openapi/section/common-use-cases/getting-asset-file-versions","content":null},{"type":"link","label":"Editing asset metadata","link":"/dash/openapi/section/common-use-cases/editing-asset-metadata","routeSlug":"/dash/openapi/section/common-use-cases/editing-asset-metadata","content":null},{"type":"link","label":"Getting user collections","link":"/dash/openapi/section/common-use-cases/getting-user-collections","routeSlug":"/dash/openapi/section/common-use-cases/getting-user-collections","content":null},{"type":"link","label":"Search by file extension","link":"/dash/openapi/section/common-use-cases/search-by-file-extension","routeSlug":"/dash/openapi/section/common-use-cases/search-by-file-extension","content":null},{"type":"link","label":"Searching for changed assets","link":"/dash/openapi/section/common-use-cases/searching-for-changed-assets","routeSlug":"/dash/openapi/section/common-use-cases/searching-for-changed-assets","content":null}],"content":null},{"type":"group","label":"Migration from V1","link":"/dash/openapi/section/migration-from-v1","routeSlug":"/dash/openapi/section/migration-from-v1","items":[{"type":"link","label":"Domain","link":"/dash/openapi/section/migration-from-v1/domain","routeSlug":"/dash/openapi/section/migration-from-v1/domain","content":null},{"type":"link","label":"Asset Staging Workflow","link":"/dash/openapi/section/migration-from-v1/asset-staging-workflow","routeSlug":"/dash/openapi/section/migration-from-v1/asset-staging-workflow","content":null},{"type":"link","label":"Asset Searches","link":"/dash/openapi/section/migration-from-v1/asset-searches","routeSlug":"/dash/openapi/section/migration-from-v1/asset-searches","content":null},{"type":"link","label":"Asset Deletion","link":"/dash/openapi/section/migration-from-v1/asset-deletion","routeSlug":"/dash/openapi/section/migration-from-v1/asset-deletion","content":null},{"type":"link","label":"Asset Metadata Edit","link":"/dash/openapi/section/migration-from-v1/asset-metadata-edit","routeSlug":"/dash/openapi/section/migration-from-v1/asset-metadata-edit","content":null},{"type":"link","label":"Search Filters","link":"/dash/openapi/section/migration-from-v1/search-filters","routeSlug":"/dash/openapi/section/migration-from-v1/search-filters","content":null},{"type":"link","label":"Saved Search","link":"/dash/openapi/section/migration-from-v1/saved-search","routeSlug":"/dash/openapi/section/migration-from-v1/saved-search","content":null},{"type":"link","label":"Attributes/Fields","link":"/dash/openapi/section/migration-from-v1/attributesfields","routeSlug":"/dash/openapi/section/migration-from-v1/attributesfields","content":null}],"content":null},{"type":"separator","label":"Account","content":null},{"type":"group","label":"Accounts","link":"/dash/openapi/accounts","routeSlug":"/dash/openapi/accounts","items":[{"label":"Create an account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/accounts/postaccounts","routeSlug":"/dash/openapi/accounts/postaccounts","metadata":{"seo":{"title":"Create an account","description":"Create an [Account]"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postAccounts","name":"Create an account","isWebhook":false,"pointer":"/paths/~1accounts/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an account","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":"Create an ["},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"]"},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"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":"This endpoint is unauthenticated. Do not send a Bearer Token in the Authorization Header"},"children":[]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AccountRequest"}},"schemaId":"components/schemas/AccountRequest","pointer":"/paths/~1accounts/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/accounts","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AccountRequest"}},"responseCodes":["200","4XX"],"pointer":"/accounts","href":"accounts/postaccounts","openApiOperationId":"postAccounts","summary":"Create an account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/AccountRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AccountRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountWithPermittedActions"}},"schemaId":"components/schemas/AccountWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1accounts/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AccountWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/accounts/postaccounts"}],"panels":[]}]},"httpPath":"/accounts"},{"label":"Request an invite to an account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/accounts/postaccountinviterequest","routeSlug":"/dash/openapi/accounts/postaccountinviterequest","metadata":{"seo":{"title":"Request an invite to an account","description":"Create a new [AccountInviteRequest]"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postAccountInviteRequest","name":"Request an invite to an account","isWebhook":false,"pointer":"/paths/~1account-invite-requests/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Request an invite to an account","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":"Create a new ["},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AccountInviteRequest"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint is unauthenticated. Do not send a Bearer Token in the Authorization Header"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AccountInviteRequest"}},"schemaId":"components/schemas/AccountInviteRequest","pointer":"/paths/~1account-invite-requests/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/account-invite-requests","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AccountInviteRequest"}},"responseCodes":["204","4XX"],"pointer":"/account-invite-requests","href":"accounts/postaccountinviterequest","openApiOperationId":"postAccountInviteRequest","summary":"Request an invite to an account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/AccountInviteRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AccountInviteRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1account-invite-requests/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/accounts/postaccountinviterequest"}],"panels":[]}]},"httpPath":"/account-invite-requests"},{"label":"Search for publicly available account data","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/accounts/postpubliclyavailableaccountdatasearches","routeSlug":"/dash/openapi/accounts/postpubliclyavailableaccountdatasearches","metadata":{"seo":{"title":"Search for publicly available account data","description":"Create a new PubliclyAvailableAccountData."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postPubliclyAvailableAccountDataSearches","name":"Search for publicly available account data","isWebhook":false,"pointer":"/paths/~1publicly-available-account-data-searches/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search for publicly available account data","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":"Create a new "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/accounts/postpubliclyavailableaccountdatasearches"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PubliclyAvailableAccountData"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint is unauthenticated. Do not send a Bearer Token in the Authorization Header"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PubliclyAvailableAccountDataSearchRequest"}},"schemaId":"components/schemas/PubliclyAvailableAccountDataSearchRequest","pointer":"/paths/~1publicly-available-account-data-searches/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/publicly-available-account-data-searches","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/PubliclyAvailableAccountDataSearchRequest"}},"responseCodes":["200","4XX"],"pointer":"/publicly-available-account-data-searches","href":"accounts/postpubliclyavailableaccountdatasearches","openApiOperationId":"postPubliclyAvailableAccountDataSearches","summary":"Search for publicly available account data"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/PubliclyAvailableAccountDataSearchRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PubliclyAvailableAccountDataSearchRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PubliclyAvailableAccountDataSearch"}},"schemaId":"components/schemas/PubliclyAvailableAccountDataSearch"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1publicly-available-account-data-searches/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PubliclyAvailableAccountDataSearch","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PubliclyAvailableAccountDataSearch"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/accounts/postpubliclyavailableaccountdatasearches"}],"panels":[]}]},"httpPath":"/publicly-available-account-data-searches"},{"label":"Get account billing info","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/accounts/getbillinginfo","routeSlug":"/dash/openapi/accounts/getbillinginfo","metadata":{"seo":{"title":"Get account billing info","description":"Get billing information for the account inferred from the Bearer Token."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getBillingInfo","name":"Get account billing info","isWebhook":false,"pointer":"/paths/~1billing-info/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get account billing info","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get billing information for the account inferred from the Bearer Token.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/billing-info","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","4XX"],"pointer":"/billing-info","href":"accounts/getbillinginfo","openApiOperationId":"getBillingInfo","summary":"Get account billing info"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BillingInfo"}},"schemaId":"components/schemas/BillingInfo"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1billing-info/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/BillingInfo","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BillingInfo"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/accounts/getbillinginfo"}],"panels":[]}]},"httpPath":"/billing-info"}],"content":{"contentType":"group","meta":{"name":"Accounts"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Accounts","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Coming soon; "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"mailto:help@dash.app"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contact us"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if you need access to this API endpoint."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/accounts","summary":"Create an account","prefix":{"name":"post","color":"post"},"badges":[],"link":"/accounts/postaccounts","deprecated":false},{"title":"/account-invite-requests","summary":"Request an invite to an account","prefix":{"name":"post","color":"post"},"badges":[],"link":"/accounts/postaccountinviterequest","deprecated":false},{"title":"/publicly-available-account-data-searches","summary":"Search for publicly available account data","prefix":{"name":"post","color":"post"},"badges":[],"link":"/accounts/postpubliclyavailableaccountdatasearches","deprecated":false},{"title":"/billing-info","summary":"Get account billing info","prefix":{"name":"get","color":"get"},"badges":[],"link":"/accounts/getbillinginfo","deprecated":false}]}]}]}]}},{"type":"group","label":"Account Security","link":"/dash/openapi/account-security","routeSlug":"/dash/openapi/account-security","items":[{"label":"Get the account security","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/account-security/getaccountsecurity","routeSlug":"/dash/openapi/account-security/getaccountsecurity","metadata":{"seo":{"title":"Get the account security","description":"Get the account security"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAccountSecurity","name":"Get the account security","isWebhook":false,"pointer":"/paths/~1account-security/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get the account security","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/account-security","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","4XX"],"pointer":"/account-security","href":"account-security/getaccountsecurity","openApiOperationId":"getAccountSecurity","summary":"Get the account security"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountSecurityWithPermittedActions"}},"schemaId":"components/schemas/AccountSecurityWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1account-security/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AccountSecurityWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountSecurityWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-security/getaccountsecurity"}],"panels":[]}]},"httpPath":"/account-security"},{"label":"Update the account security","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/account-security/putaccountsecurity","routeSlug":"/dash/openapi/account-security/putaccountsecurity","metadata":{"seo":{"title":"Update the account security","description":"Update the account security"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"putAccountSecurity","name":"Update the account security","isWebhook":false,"pointer":"/paths/~1account-security/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update the account security","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AccountSecurityPutRequest"}},"schemaId":"components/schemas/AccountSecurityPutRequest","pointer":"/paths/~1account-security/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/account-security","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AccountSecurityPutRequest"}},"responseCodes":["200","4XX"],"pointer":"/account-security","href":"account-security/putaccountsecurity","openApiOperationId":"putAccountSecurity","summary":"Update the account security"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/AccountSecurityPutRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AccountSecurityPutRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountSecurityWithPermittedActions"}},"schemaId":"components/schemas/AccountSecurityWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1account-security/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AccountSecurityWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountSecurityWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-security/putaccountsecurity"}],"panels":[]}]},"httpPath":"/account-security"}],"content":{"contentType":"group","meta":{"name":"Account Security"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Account Security","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Coming soon; "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"mailto:help@dash.app"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contact us"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if you need access to this API endpoint."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/account-security","summary":"Get the account security","prefix":{"name":"get","color":"get"},"badges":[],"link":"/account-security/getaccountsecurity","deprecated":false},{"title":"/account-security","summary":"Update the account security","prefix":{"name":"put","color":"put"},"badges":[],"link":"/account-security/putaccountsecurity","deprecated":false}]}]}]}]}},{"type":"group","label":"Allowed Login Methods","link":"/dash/openapi/allowed-login-methods","routeSlug":"/dash/openapi/allowed-login-methods","items":[{"label":"Update the allowed login methods","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/allowed-login-methods/putallowedloginmethods","routeSlug":"/dash/openapi/allowed-login-methods/putallowedloginmethods","metadata":{"seo":{"title":"Update the allowed login methods","description":"Update the allowed login methods"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"putAllowedLoginMethods","name":"Update the allowed login methods","isWebhook":false,"pointer":"/paths/~1allowed-login-methods/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update the allowed login methods","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AllowedLoginMethods"}},"schemaId":"components/schemas/AllowedLoginMethods","pointer":"/paths/~1allowed-login-methods/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/allowed-login-methods","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AllowedLoginMethods"}},"responseCodes":["200","4XX"],"pointer":"/allowed-login-methods","href":"allowed-login-methods/putallowedloginmethods","openApiOperationId":"putAllowedLoginMethods","summary":"Update the allowed login methods"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/AllowedLoginMethods","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AllowedLoginMethods"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AllowedLoginMethods"}},"schemaId":"components/schemas/AllowedLoginMethods"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1allowed-login-methods/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AllowedLoginMethods","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AllowedLoginMethods"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/allowed-login-methods/putallowedloginmethods"}],"panels":[]}]},"httpPath":"/allowed-login-methods"}],"content":{"contentType":"group","meta":{"name":"Allowed Login Methods"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Allowed Login Methods","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Coming soon; "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"mailto:help@dash.app"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contact us"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if you need access to this API endpoint."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/allowed-login-methods","summary":"Update the allowed login methods","prefix":{"name":"put","color":"put"},"badges":[],"link":"/allowed-login-methods/putallowedloginmethods","deprecated":false}]}]}]}]}},{"type":"group","label":"Auto-Tagging Image Settings","link":"/dash/openapi/auto-tagging-image-settings","routeSlug":"/dash/openapi/auto-tagging-image-settings","items":[{"label":"Get the account auto-tagging image settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/auto-tagging-image-settings/getautotaggingimagesettings","routeSlug":"/dash/openapi/auto-tagging-image-settings/getautotaggingimagesettings","metadata":{"seo":{"title":"Get the account auto-tagging image settings","description":"Get the account auto-tagging image settings"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAutoTaggingImageSettings","name":"Get the account auto-tagging image settings","isWebhook":false,"pointer":"/paths/~1auto-tagging-image-settings/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get the account auto-tagging image settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/auto-tagging-image-settings","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","4XX"],"pointer":"/auto-tagging-image-settings","href":"auto-tagging-image-settings/getautotaggingimagesettings","openApiOperationId":"getAutoTaggingImageSettings","summary":"Get the account auto-tagging image settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AutoTaggingImageSettingsWithPermittedActions"}},"schemaId":"components/schemas/AutoTaggingImageSettingsWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1auto-tagging-image-settings/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AutoTaggingImageSettingsWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AutoTaggingImageSettingsWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/auto-tagging-image-settings/getautotaggingimagesettings"}],"panels":[]}]},"httpPath":"/auto-tagging-image-settings"},{"label":"Update the account auto-tagging image settings","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/auto-tagging-image-settings/patchautotaggingimagesettings","routeSlug":"/dash/openapi/auto-tagging-image-settings/patchautotaggingimagesettings","metadata":{"seo":{"title":"Update the account auto-tagging image settings","description":"Update the account auto-tagging image settings"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchAutoTaggingImageSettings","name":"Update the account auto-tagging image settings","isWebhook":false,"pointer":"/paths/~1auto-tagging-image-settings/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update the account auto-tagging image settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AutoTaggingImageSettingsPatchRequest"}},"schemaId":"components/schemas/AutoTaggingImageSettingsPatchRequest","pointer":"/paths/~1auto-tagging-image-settings/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/auto-tagging-image-settings","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AutoTaggingImageSettingsPatchRequest"}},"responseCodes":["200","4XX"],"pointer":"/auto-tagging-image-settings","href":"auto-tagging-image-settings/patchautotaggingimagesettings","openApiOperationId":"patchAutoTaggingImageSettings","summary":"Update the account auto-tagging image settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/AutoTaggingImageSettingsPatchRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AutoTaggingImageSettingsPatchRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AutoTaggingImageSettingsWithPermittedActions"}},"schemaId":"components/schemas/AutoTaggingImageSettingsWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1auto-tagging-image-settings/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AutoTaggingImageSettingsWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AutoTaggingImageSettingsWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/auto-tagging-image-settings/patchautotaggingimagesettings"}],"panels":[]}]},"httpPath":"/auto-tagging-image-settings"}],"content":{"contentType":"group","meta":{"name":"Auto-Tagging Image Settings"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Auto-Tagging Image Settings","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Coming soon; "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"mailto:help@dash.app"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contact us"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if you need access to this API endpoint."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/auto-tagging-image-settings","summary":"Get the account auto-tagging image settings","prefix":{"name":"get","color":"get"},"badges":[],"link":"/auto-tagging-image-settings/getautotaggingimagesettings","deprecated":false},{"title":"/auto-tagging-image-settings","summary":"Update the account auto-tagging image settings","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/auto-tagging-image-settings/patchautotaggingimagesettings","deprecated":false}]}]}]}]}},{"type":"group","label":"Entity Quota Overrides","link":"/dash/openapi/entity-quota-overrides","routeSlug":"/dash/openapi/entity-quota-overrides","items":[{"label":"Get an EntityQuotaOverride","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/entity-quota-overrides/getentityquotaoverride","routeSlug":"/dash/openapi/entity-quota-overrides/getentityquotaoverride","metadata":{"seo":{"title":"Get an EntityQuotaOverride","description":"Get the EntityQuotaOverride for the specified entity."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEntityQuotaOverride","name":"Get an EntityQuotaOverride","isWebhook":false,"pointer":"/paths/~1admin~1accounts~1{accountId}~1entities~1{id}~1quota-override/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get an EntityQuotaOverride","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":"Get the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/EntityQuotaOverride"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EntityQuotaOverride"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the specified entity."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid entity IDs are:"},"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":"user"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"guestUpload"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"portal"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"savedSearch"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"presetSize"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"group"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"comment"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"assetShare"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"embeddableLink"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"embeddedDataMapping"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"field"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"fieldOption"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"collection"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"accountId","in":"path","schemaId":"schema_25","description":"The ID of the account","required":true},{"name":"id","in":"path","schemaId":"schema_25","description":"The ID of the entity","required":true}],"pointer":"/paths/~1admin~1accounts~1{accountId}~1entities~1{id}~1quota-override/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/admin/accounts/{accountId}/entities/{id}/quota-override","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"accountId","in":"path","required":true,"schemaId":"schema_25"},{"name":"id","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","4XX"],"pointer":"/admin/accounts/{accountId}/entities/{id}/quota-override","href":"entity-quota-overrides/getentityquotaoverride","openApiOperationId":"getEntityQuotaOverride","summary":"Get an EntityQuotaOverride"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EntityQuotaOverrideWithPermittedActions"}},"schemaId":"components/schemas/EntityQuotaOverrideWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1admin~1accounts~1{accountId}~1entities~1{id}~1quota-override/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/EntityQuotaOverrideWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EntityQuotaOverrideWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/entity-quota-overrides/getentityquotaoverride"}],"panels":[]}]},"httpPath":"/admin/accounts/{accountId}/entities/{id}/quota-override"},{"label":"Create or update an EntityQuotaOverride","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/entity-quota-overrides/putentityquotaoverride","routeSlug":"/dash/openapi/entity-quota-overrides/putentityquotaoverride","metadata":{"seo":{"title":"Create or update an EntityQuotaOverride","description":"Create a EntityQuotaOverride for the specified entity."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"putEntityQuotaOverride","name":"Create or update an EntityQuotaOverride","isWebhook":false,"pointer":"/paths/~1admin~1accounts~1{accountId}~1entities~1{id}~1quota-override/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create or update an EntityQuotaOverride","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":"Create a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/EntityQuotaOverride"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EntityQuotaOverride"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the specified entity."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"accountId","in":"path","schemaId":"schema_25","description":"The ID of the account","required":true},{"name":"id","in":"path","schemaId":"schema_25","description":"The ID of the entity","required":true}],"pointer":"/paths/~1admin~1accounts~1{accountId}~1entities~1{id}~1quota-override/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EntityQuotaOverrideRequest"}},"schemaId":"components/schemas/EntityQuotaOverrideRequest","pointer":"/paths/~1admin~1accounts~1{accountId}~1entities~1{id}~1quota-override/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/admin/accounts/{accountId}/entities/{id}/quota-override","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"accountId","in":"path","required":true,"schemaId":"schema_25"},{"name":"id","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EntityQuotaOverrideRequest"}},"responseCodes":["200","4XX"],"pointer":"/admin/accounts/{accountId}/entities/{id}/quota-override","href":"entity-quota-overrides/putentityquotaoverride","openApiOperationId":"putEntityQuotaOverride","summary":"Create or update an EntityQuotaOverride"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/EntityQuotaOverrideRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EntityQuotaOverrideRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EntityQuotaOverrideWithPermittedActions"}},"schemaId":"components/schemas/EntityQuotaOverrideWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1admin~1accounts~1{accountId}~1entities~1{id}~1quota-override/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/EntityQuotaOverrideWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EntityQuotaOverrideWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/entity-quota-overrides/putentityquotaoverride"}],"panels":[]}]},"httpPath":"/admin/accounts/{accountId}/entities/{id}/quota-override"}],"content":{"contentType":"group","meta":{"name":"Entity Quota Overrides"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Entity Quota Overrides","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Coming soon; "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"mailto:help@dash.app"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contact us"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if you need access to this API endpoint."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/admin/accounts/{accountId}/entities/{id}/quota-override","summary":"Get an EntityQuotaOverride","prefix":{"name":"get","color":"get"},"badges":[],"link":"/entity-quota-overrides/getentityquotaoverride","deprecated":false},{"title":"/admin/accounts/{accountId}/entities/{id}/quota-override","summary":"Create or update an EntityQuotaOverride","prefix":{"name":"put","color":"put"},"badges":[],"link":"/entity-quota-overrides/putentityquotaoverride","deprecated":false}]}]}]}]}},{"type":"group","label":"Folder Settings","link":"/dash/openapi/folder-settings","routeSlug":"/dash/openapi/folder-settings","items":[{"label":"Get the account folder settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/folder-settings/getfoldersettings","routeSlug":"/dash/openapi/folder-settings/getfoldersettings","metadata":{"seo":{"title":"Get the account folder settings","description":"Get the account folder settings"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getFolderSettings","name":"Get the account folder settings","isWebhook":false,"pointer":"/paths/~1folder-settings/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get the account folder settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/folder-settings","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","4XX"],"pointer":"/folder-settings","href":"folder-settings/getfoldersettings","openApiOperationId":"getFolderSettings","summary":"Get the account folder settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FolderSettingsWithPermittedActions"}},"schemaId":"components/schemas/FolderSettingsWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1folder-settings/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/FolderSettingsWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FolderSettingsWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/folder-settings/getfoldersettings"}],"panels":[]}]},"httpPath":"/folder-settings"}],"content":{"contentType":"group","meta":{"name":"Folder Settings"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Folder Settings","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For the most part Folders in Dash are just like any custom "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field.hasFixedOptions = true"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field.hierarchical = true"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field.multiValue = true"},"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 Folders "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" also has the following behaviour."},"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":"It cannot be deleted - "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field.indestructable = true"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is used to define "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"  permissions for a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UserGroup"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (currently only configurable via the Dash frontend, not via the API)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A quick browse widget of your Folders "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" appears on your Dash app homepage."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Folder Settings specify the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field.id"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the Folders "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in your Dash."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/folder-settings","summary":"Get the account folder settings","prefix":{"name":"get","color":"get"},"badges":[],"link":"/folder-settings/getfoldersettings","deprecated":false}]}]}]}]}},{"type":"group","label":"Onboarding Checklist","link":"/dash/openapi/onboarding-checklist","routeSlug":"/dash/openapi/onboarding-checklist","items":[{"label":"Get the account onboarding checklist","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/onboarding-checklist/getonboardingchecklist","routeSlug":"/dash/openapi/onboarding-checklist/getonboardingchecklist","metadata":{"seo":{"title":"Get the account onboarding checklist","description":"Get the account onboarding checklist"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getOnboardingChecklist","name":"Get the account onboarding checklist","isWebhook":false,"pointer":"/paths/~1onboarding-checklist/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get the account onboarding checklist","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/onboarding-checklist","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","4XX"],"pointer":"/onboarding-checklist","href":"onboarding-checklist/getonboardingchecklist","openApiOperationId":"getOnboardingChecklist","summary":"Get the account onboarding checklist"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OnboardingChecklistWithPermittedActions"}},"schemaId":"components/schemas/OnboardingChecklistWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1onboarding-checklist/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/OnboardingChecklistWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OnboardingChecklistWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/onboarding-checklist/getonboardingchecklist"}],"panels":[]}]},"httpPath":"/onboarding-checklist"},{"label":"Update the account onboarding checklist","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/onboarding-checklist/patchonboardingchecklist","routeSlug":"/dash/openapi/onboarding-checklist/patchonboardingchecklist","metadata":{"seo":{"title":"Update the account onboarding checklist","description":"Update the account onboarding checklist"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchOnboardingChecklist","name":"Update the account onboarding checklist","isWebhook":false,"pointer":"/paths/~1onboarding-checklist/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update the account onboarding checklist","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OnboardingChecklistPatchRequest"}},"schemaId":"components/schemas/OnboardingChecklistPatchRequest","pointer":"/paths/~1onboarding-checklist/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/onboarding-checklist","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OnboardingChecklistPatchRequest"}},"responseCodes":["200","4XX"],"pointer":"/onboarding-checklist","href":"onboarding-checklist/patchonboardingchecklist","openApiOperationId":"patchOnboardingChecklist","summary":"Update the account onboarding checklist"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/OnboardingChecklistPatchRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OnboardingChecklistPatchRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OnboardingChecklistWithPermittedActions"}},"schemaId":"components/schemas/OnboardingChecklistWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1onboarding-checklist/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/OnboardingChecklistWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OnboardingChecklistWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/onboarding-checklist/patchonboardingchecklist"}],"panels":[]}]},"httpPath":"/onboarding-checklist"},{"label":"Get the dynamic account onboarding checklist","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/onboarding-checklist/getdynamiconboardingchecklist","routeSlug":"/dash/openapi/onboarding-checklist/getdynamiconboardingchecklist","metadata":{"seo":{"title":"Get the dynamic account onboarding checklist","description":"Get the dynamic account onboarding checklist"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDynamicOnboardingChecklist","name":"Get the dynamic account onboarding checklist","isWebhook":false,"pointer":"/paths/~1dynamic-onboarding-checklist/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get the dynamic account onboarding checklist","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/dynamic-onboarding-checklist","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","4XX"],"pointer":"/dynamic-onboarding-checklist","href":"onboarding-checklist/getdynamiconboardingchecklist","openApiOperationId":"getDynamicOnboardingChecklist","summary":"Get the dynamic account onboarding checklist"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DynamicOnboardingChecklistWithPermittedActions"}},"schemaId":"components/schemas/DynamicOnboardingChecklistWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1dynamic-onboarding-checklist/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/DynamicOnboardingChecklistWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DynamicOnboardingChecklistWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/onboarding-checklist/getdynamiconboardingchecklist"}],"panels":[]}]},"httpPath":"/dynamic-onboarding-checklist"},{"label":"Update the dynamic account onboarding checklist","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/onboarding-checklist/patchdynamiconboardingchecklist","routeSlug":"/dash/openapi/onboarding-checklist/patchdynamiconboardingchecklist","metadata":{"seo":{"title":"Update the dynamic account onboarding checklist","description":"Update the dynamic account onboarding checklist"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchDynamicOnboardingChecklist","name":"Update the dynamic account onboarding checklist","isWebhook":false,"pointer":"/paths/~1dynamic-onboarding-checklist/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update the dynamic account onboarding checklist","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DynamicOnboardingChecklistPatchRequest"}},"schemaId":"components/schemas/DynamicOnboardingChecklistPatchRequest","pointer":"/paths/~1dynamic-onboarding-checklist/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/dynamic-onboarding-checklist","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DynamicOnboardingChecklistPatchRequest"}},"responseCodes":["200","4XX"],"pointer":"/dynamic-onboarding-checklist","href":"onboarding-checklist/patchdynamiconboardingchecklist","openApiOperationId":"patchDynamicOnboardingChecklist","summary":"Update the dynamic account onboarding checklist"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/DynamicOnboardingChecklistPatchRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DynamicOnboardingChecklistPatchRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DynamicOnboardingChecklistWithPermittedActions"}},"schemaId":"components/schemas/DynamicOnboardingChecklistWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1dynamic-onboarding-checklist/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/DynamicOnboardingChecklistWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DynamicOnboardingChecklistWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/onboarding-checklist/patchdynamiconboardingchecklist"}],"panels":[]}]},"httpPath":"/dynamic-onboarding-checklist"}],"content":{"contentType":"group","meta":{"name":"Onboarding Checklist"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Onboarding Checklist","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Coming soon; "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"mailto:help@dash.app"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contact us"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if you need access to this API endpoint."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/onboarding-checklist","summary":"Get the account onboarding checklist","prefix":{"name":"get","color":"get"},"badges":[],"link":"/onboarding-checklist/getonboardingchecklist","deprecated":false},{"title":"/onboarding-checklist","summary":"Update the account onboarding checklist","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/onboarding-checklist/patchonboardingchecklist","deprecated":false},{"title":"/dynamic-onboarding-checklist","summary":"Get the dynamic account onboarding checklist","prefix":{"name":"get","color":"get"},"badges":[],"link":"/onboarding-checklist/getdynamiconboardingchecklist","deprecated":false},{"title":"/dynamic-onboarding-checklist","summary":"Update the dynamic account onboarding checklist","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/onboarding-checklist/patchdynamiconboardingchecklist","deprecated":false}]}]}]}]}},{"type":"group","label":"Preset Transformations","link":"/dash/openapi/preset-transformations","routeSlug":"/dash/openapi/preset-transformations","items":[{"label":"Get grouped preset transformations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/preset-transformations/getgroupedpresettransformations","routeSlug":"/dash/openapi/preset-transformations/getgroupedpresettransformations","metadata":{"seo":{"title":"Get grouped preset transformations","description":"Get all PresetTransformations for the account in a group structure."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getGroupedPresetTransformations","name":"Get grouped preset transformations","isWebhook":false,"pointer":"/paths/~1grouped-preset-transformations/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get grouped preset transformations","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":"Get all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Preset-Transformations"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PresetTransformations"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the account in a group structure."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/grouped-preset-transformations","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","4XX"],"pointer":"/grouped-preset-transformations","href":"preset-transformations/getgroupedpresettransformations","openApiOperationId":"getGroupedPresetTransformations","summary":"Get grouped preset transformations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GroupedPresetTransformationsWithPermittedActions"}},"schemaId":"components/schemas/GroupedPresetTransformationsWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1grouped-preset-transformations/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GroupedPresetTransformationsWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GroupedPresetTransformationsWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/preset-transformations/getgroupedpresettransformations"}],"panels":[]}]},"httpPath":"/grouped-preset-transformations"},{"label":"Search for preset transformations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/preset-transformations/postpresettransformationsearch","routeSlug":"/dash/openapi/preset-transformations/postpresettransformationsearch","metadata":{"seo":{"title":"Search for preset transformations","description":"Create a new PresetTransformationSearch.  This is most commonly used for finding presets that are applicable to a set of assets, so that one can be selected for use to create some AssetDownloads."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postPresetTransformationSearch","name":"Search for preset transformations","isWebhook":false,"pointer":"/paths/~1preset-transformation-searches/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search for preset transformations","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":"Create a new "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/preset-transformations/postpresettransformationsearch"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PresetTransformationSearch"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":".  This is most commonly used for finding presets that are applicable to a set of assets, so that one can be selected for use to create some "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Asset-Downloads"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetDownloads"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PresetTransformationSearchRequest","exampleIds":["paths/~1preset-transformation-searches/post/requestBody/content/application~1json/examples/Search for non-crop presets that can be used with specified set of assets"]}},"schemaId":"components/schemas/PresetTransformationSearchRequest","exampleIds":["paths/~1preset-transformation-searches/post/requestBody/content/application~1json/examples/Search for non-crop presets that can be used with specified set of assets"],"pointer":"/paths/~1preset-transformation-searches/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/preset-transformation-searches","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PresetTransformationSearchRequest","exampleIds":["paths/~1preset-transformation-searches/post/requestBody/content/application~1json/examples/Search for non-crop presets that can be used with specified set of assets"]}},"responseCodes":["200","4XX"],"pointer":"/preset-transformation-searches","href":"preset-transformations/postpresettransformationsearch","openApiOperationId":"postPresetTransformationSearch","summary":"Search for preset transformations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/PresetTransformationSearchRequest","exampleIds":["paths/~1preset-transformation-searches/post/requestBody/content/application~1json/examples/Search for non-crop presets that can be used with specified set of assets"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PresetTransformationSearchRequest","exampleIds":["paths/~1preset-transformation-searches/post/requestBody/content/application~1json/examples/Search for non-crop presets that can be used with specified set of assets"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PresetTransformationSearch","exampleIds":["paths/~1preset-transformation-searches/post/responses/200/content/application~1json/examples/Search for non-crop presets that can be used with specified set of assets"]}},"schemaId":"components/schemas/PresetTransformationSearch","exampleIds":["paths/~1preset-transformation-searches/post/responses/200/content/application~1json/examples/Search for non-crop presets that can be used with specified set of assets"]},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1preset-transformation-searches/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PresetTransformationSearch","exampleIds":["paths/~1preset-transformation-searches/post/responses/200/content/application~1json/examples/Search for non-crop presets that can be used with specified set of assets"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PresetTransformationSearch","exampleIds":["paths/~1preset-transformation-searches/post/responses/200/content/application~1json/examples/Search for non-crop presets that can be used with specified set of assets"]}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/preset-transformations/postpresettransformationsearch"}],"panels":[]}]},"httpPath":"/preset-transformation-searches"},{"label":"Search for preset transformations for assets","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/preset-transformations/postpresettransformationsforassetsearch","routeSlug":"/dash/openapi/preset-transformations/postpresettransformationsforassetsearch","metadata":{"seo":{"title":"Search for preset transformations for assets","description":"Create a new [PresetTransformationsForAssetSearch]"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postPresetTransformationsForAssetSearch","name":"Search for preset transformations for assets","isWebhook":false,"pointer":"/paths/~1preset-transformations-for-asset-searches/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search for preset transformations for assets","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":"Create a new ["},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PresetTransformationsForAssetSearch"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"]"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PresetTransformationsForAssetSearchRequest"}},"schemaId":"components/schemas/PresetTransformationsForAssetSearchRequest","pointer":"/paths/~1preset-transformations-for-asset-searches/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/preset-transformations-for-asset-searches","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PresetTransformationsForAssetSearchRequest"}},"responseCodes":["200","4XX"],"pointer":"/preset-transformations-for-asset-searches","href":"preset-transformations/postpresettransformationsforassetsearch","openApiOperationId":"postPresetTransformationsForAssetSearch","summary":"Search for preset transformations for assets"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/PresetTransformationsForAssetSearchRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PresetTransformationsForAssetSearchRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PresetTransformationsForAssetSearch"}},"schemaId":"components/schemas/PresetTransformationsForAssetSearch"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1preset-transformations-for-asset-searches/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PresetTransformationsForAssetSearch","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PresetTransformationsForAssetSearch"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/preset-transformations/postpresettransformationsforassetsearch"}],"panels":[]}]},"httpPath":"/preset-transformations-for-asset-searches"}],"content":{"contentType":"group","meta":{"name":"Preset Transformations"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Preset Transformations","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/grouped-preset-transformations","summary":"Get grouped preset transformations","prefix":{"name":"get","color":"get"},"badges":[],"link":"/preset-transformations/getgroupedpresettransformations","deprecated":false},{"title":"/preset-transformation-searches","summary":"Search for preset transformations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/preset-transformations/postpresettransformationsearch","deprecated":false},{"title":"/preset-transformations-for-asset-searches","summary":"Search for preset transformations for assets","prefix":{"name":"post","color":"post"},"badges":[],"link":"/preset-transformations/postpresettransformationsforassetsearch","deprecated":false}]}]}]}]}},{"type":"group","label":"Search Filters","link":"/dash/openapi/search-filters","routeSlug":"/dash/openapi/search-filters","items":[{"label":"Get all search filters","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/search-filters/getsearchfilters","routeSlug":"/dash/openapi/search-filters/getsearchfilters","metadata":{"seo":{"title":"Get all search filters","description":"Get the SearchFilter resources"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSearchFilters","name":"Get all search filters","isWebhook":false,"pointer":"/paths/~1search-filters/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all search filters","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":"Get the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Search-Filters"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SearchFilter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/search-filters","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","4XX"],"pointer":"/search-filters","href":"search-filters/getsearchfilters","openApiOperationId":"getSearchFilters","summary":"Get all search filters"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_26"}},"schemaId":"schema_26"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1search-filters/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_26","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_26"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/search-filters/getsearchfilters"}],"panels":[]}]},"httpPath":"/search-filters"},{"label":"Get the account search filter view","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/search-filters/getsearchfilterview","routeSlug":"/dash/openapi/search-filters/getsearchfilterview","metadata":{"seo":{"title":"Get the account search filter view","description":"Get the SearchFilter resources that have been configured as in use"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSearchFilterView","name":"Get the account search filter view","isWebhook":false,"pointer":"/paths/~1search-filter-view/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get the account search filter view","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":"Get the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Search-Filters"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SearchFilter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources that have been configured as in use"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/search-filter-view","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","4XX"],"pointer":"/search-filter-view","href":"search-filters/getsearchfilterview","openApiOperationId":"getSearchFilterView","summary":"Get the account search filter view"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SearchFilterViewWithPermittedActions","exampleIds":["paths/~1search-filter-view/get/responses/200/content/application~1json/examples/View"]}},"schemaId":"components/schemas/SearchFilterViewWithPermittedActions","exampleIds":["paths/~1search-filter-view/get/responses/200/content/application~1json/examples/View"]},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1search-filter-view/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SearchFilterViewWithPermittedActions","exampleIds":["paths/~1search-filter-view/get/responses/200/content/application~1json/examples/View"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SearchFilterViewWithPermittedActions","exampleIds":["paths/~1search-filter-view/get/responses/200/content/application~1json/examples/View"]}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/search-filters/getsearchfilterview"}],"panels":[]}]},"httpPath":"/search-filter-view"},{"label":"Add a search filter to the account search filter view","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/search-filters/postsearchfilterviewsearchfilter","routeSlug":"/dash/openapi/search-filters/postsearchfilterviewsearchfilter","metadata":{"seo":{"title":"Add a search filter to the account search filter view","description":"Configure a SearchFilter resource as in-use"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postSearchFilterViewSearchFilter","name":"Add a search filter to the account search filter view","isWebhook":false,"pointer":"/paths/~1search-filter-view~1search-filters/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add a search filter to the account search filter view","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":"Configure a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Search-Filters"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SearchFilter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource as in-use"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SearchFilterViewSearchFilterRequest"}},"schemaId":"components/schemas/SearchFilterViewSearchFilterRequest","pointer":"/paths/~1search-filter-view~1search-filters/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/search-filter-view/search-filters","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SearchFilterViewSearchFilterRequest"}},"responseCodes":["200","4XX"],"pointer":"/search-filter-view/search-filters","href":"search-filters/postsearchfilterviewsearchfilter","openApiOperationId":"postSearchFilterViewSearchFilter","summary":"Add a search filter to the account search filter view"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/SearchFilterViewSearchFilterRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SearchFilterViewSearchFilterRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SearchFilterViewWithPermittedActions","exampleIds":["paths/~1search-filter-view~1search-filters/post/responses/200/content/application~1json/examples/View"]}},"schemaId":"components/schemas/SearchFilterViewWithPermittedActions","exampleIds":["paths/~1search-filter-view~1search-filters/post/responses/200/content/application~1json/examples/View"]},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1search-filter-view~1search-filters/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SearchFilterViewWithPermittedActions","exampleIds":["paths/~1search-filter-view~1search-filters/post/responses/200/content/application~1json/examples/View"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SearchFilterViewWithPermittedActions","exampleIds":["paths/~1search-filter-view~1search-filters/post/responses/200/content/application~1json/examples/View"]}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/search-filters/postsearchfilterviewsearchfilter"}],"panels":[]}]},"httpPath":"/search-filter-view/search-filters"},{"label":"Patch a search filter in the account search filter view","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/search-filters/patchsearchfilterviewsearchfilter","routeSlug":"/dash/openapi/search-filters/patchsearchfilterviewsearchfilter","metadata":{"seo":{"title":"Patch a search filter in the account search filter view","description":"Change the display position of a SearchFilter resource in the search filter view"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchSearchFilterViewSearchFilter","name":"Patch a search filter in the account search filter view","isWebhook":false,"pointer":"/paths/~1search-filter-view~1search-filters~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Patch a search filter in the account search filter view","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":"Change the display position of a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Search-Filters"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SearchFilter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource in the search filter view"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Search-Filters"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SearchFilter"},"children":[]}]}]}]}],"required":true}],"pointer":"/paths/~1search-filter-view~1search-filters~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SearchFilterViewSearchFilterPatchRequest"}},"schemaId":"components/schemas/SearchFilterViewSearchFilterPatchRequest","pointer":"/paths/~1search-filter-view~1search-filters~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/search-filter-view/search-filters/{id}","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SearchFilterViewSearchFilterPatchRequest"}},"responseCodes":["200","4XX"],"pointer":"/search-filter-view/search-filters/{id}","href":"search-filters/patchsearchfilterviewsearchfilter","openApiOperationId":"patchSearchFilterViewSearchFilter","summary":"Patch a search filter in the account search filter view"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/SearchFilterViewSearchFilterPatchRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SearchFilterViewSearchFilterPatchRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SearchFilterViewWithPermittedActions","exampleIds":["paths/~1search-filter-view~1search-filters~1{id}/patch/responses/200/content/application~1json/examples/View"]}},"schemaId":"components/schemas/SearchFilterViewWithPermittedActions","exampleIds":["paths/~1search-filter-view~1search-filters~1{id}/patch/responses/200/content/application~1json/examples/View"]},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1search-filter-view~1search-filters~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SearchFilterViewWithPermittedActions","exampleIds":["paths/~1search-filter-view~1search-filters~1{id}/patch/responses/200/content/application~1json/examples/View"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SearchFilterViewWithPermittedActions","exampleIds":["paths/~1search-filter-view~1search-filters~1{id}/patch/responses/200/content/application~1json/examples/View"]}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/search-filters/patchsearchfilterviewsearchfilter"}],"panels":[]}]},"httpPath":"/search-filter-view/search-filters/{id}"},{"label":"Delete a search filter from the account search filter view","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/search-filters/deletesearchfilterviewsearchfilter","routeSlug":"/dash/openapi/search-filters/deletesearchfilterviewsearchfilter","metadata":{"seo":{"title":"Delete a search filter from the account search filter view","description":"Configure a SearchFilter resource as not in-use"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteSearchFilterViewSearchFilter","name":"Delete a search filter from the account search filter view","isWebhook":false,"pointer":"/paths/~1search-filter-view~1search-filters~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a search filter from the account search filter view","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":"Configure a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Search-Filters"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SearchFilter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource as not in-use"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Search-Filters"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SearchFilter"},"children":[]}]}]}]}],"required":true}],"pointer":"/paths/~1search-filter-view~1search-filters~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/search-filter-view/search-filters/{id}","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","4XX"],"pointer":"/search-filter-view/search-filters/{id}","href":"search-filters/deletesearchfilterviewsearchfilter","openApiOperationId":"deleteSearchFilterViewSearchFilter","summary":"Delete a search filter from the account search filter view"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SearchFilterViewWithPermittedActions","exampleIds":["paths/~1search-filter-view~1search-filters~1{id}/delete/responses/200/content/application~1json/examples/View"]}},"schemaId":"components/schemas/SearchFilterViewWithPermittedActions","exampleIds":["paths/~1search-filter-view~1search-filters~1{id}/delete/responses/200/content/application~1json/examples/View"]},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1search-filter-view~1search-filters~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SearchFilterViewWithPermittedActions","exampleIds":["paths/~1search-filter-view~1search-filters~1{id}/delete/responses/200/content/application~1json/examples/View"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SearchFilterViewWithPermittedActions","exampleIds":["paths/~1search-filter-view~1search-filters~1{id}/delete/responses/200/content/application~1json/examples/View"]}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/search-filters/deletesearchfilterviewsearchfilter"}],"panels":[]}]},"httpPath":"/search-filter-view/search-filters/{id}"}],"content":{"contentType":"group","meta":{"name":"Search Filters"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search Filters","showPageActions":true},{"nodeType":"markdoc","content":[{"$$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":"link","inline":true,"attributes":{"href":"/dash/openapi/search-filters/getsearchfilters"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search Filter View"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" defines which filters appear, and the order in which they appear, in the left hand filter bar on the search page in the Dash frontend."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These filters are used to build search criteria."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters either refer to a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in your Dash or a one of a subset of the fixed search fields available in the search API (currently "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DATE_LIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FILE_TYPE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STAGED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/search-filters","summary":"Get all search filters","prefix":{"name":"get","color":"get"},"badges":[],"link":"/search-filters/getsearchfilters","deprecated":false},{"title":"/search-filter-view","summary":"Get the account search filter view","prefix":{"name":"get","color":"get"},"badges":[],"link":"/search-filters/getsearchfilterview","deprecated":false},{"title":"/search-filter-view/search-filters","summary":"Add a search filter to the account search filter view","prefix":{"name":"post","color":"post"},"badges":[],"link":"/search-filters/postsearchfilterviewsearchfilter","deprecated":false},{"title":"/search-filter-view/search-filters/{id}","summary":"Patch a search filter in the account search filter view","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/search-filters/patchsearchfilterviewsearchfilter","deprecated":false},{"title":"/search-filter-view/search-filters/{id}","summary":"Delete a search filter from the account search filter view","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/search-filters/deletesearchfilterviewsearchfilter","deprecated":false}]}]}]}]}},{"type":"group","label":"Shopify SKU Settings","link":"/dash/openapi/shopify-sku-settings","routeSlug":"/dash/openapi/shopify-sku-settings","items":[{"label":"Get the account Shopify SKU settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/shopify-sku-settings/getshopifyskusettings","routeSlug":"/dash/openapi/shopify-sku-settings/getshopifyskusettings","metadata":{"seo":{"title":"Get the account Shopify SKU settings","description":"Get the account Shopify SKU settings"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getShopifySkuSettings","name":"Get the account Shopify SKU settings","isWebhook":false,"pointer":"/paths/~1shopify-sku-settings/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get the account Shopify SKU settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/shopify-sku-settings","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","4XX"],"pointer":"/shopify-sku-settings","href":"shopify-sku-settings/getshopifyskusettings","openApiOperationId":"getShopifySkuSettings","summary":"Get the account Shopify SKU settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ShopifySkuSettingsWithPermittedActions"}},"schemaId":"components/schemas/ShopifySkuSettingsWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1shopify-sku-settings/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ShopifySkuSettingsWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ShopifySkuSettingsWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shopify-sku-settings/getshopifyskusettings"}],"panels":[]}]},"httpPath":"/shopify-sku-settings"},{"label":"Create or update the account Shopify SKU settings","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/shopify-sku-settings/putshopifyskusettings","routeSlug":"/dash/openapi/shopify-sku-settings/putshopifyskusettings","metadata":{"seo":{"title":"Create or update the account Shopify SKU settings","description":"Create or update the account Shopify SKU settings"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"putShopifySkuSettings","name":"Create or update the account Shopify SKU settings","isWebhook":false,"pointer":"/paths/~1shopify-sku-settings/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create or update the account Shopify SKU settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ShopifySkuSettings"}},"schemaId":"components/schemas/ShopifySkuSettings","pointer":"/paths/~1shopify-sku-settings/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/shopify-sku-settings","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ShopifySkuSettings"}},"responseCodes":["200","4XX"],"pointer":"/shopify-sku-settings","href":"shopify-sku-settings/putshopifyskusettings","openApiOperationId":"putShopifySkuSettings","summary":"Create or update the account Shopify SKU settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/ShopifySkuSettings","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ShopifySkuSettings"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ShopifySkuSettingsWithPermittedActions"}},"schemaId":"components/schemas/ShopifySkuSettingsWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1shopify-sku-settings/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ShopifySkuSettingsWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ShopifySkuSettingsWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shopify-sku-settings/putshopifyskusettings"}],"panels":[]}]},"httpPath":"/shopify-sku-settings"},{"label":"Delete the account Shopify SKU settings","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/shopify-sku-settings/deleteshopifyskusettings","routeSlug":"/dash/openapi/shopify-sku-settings/deleteshopifyskusettings","metadata":{"seo":{"title":"Delete the account Shopify SKU settings","description":"Delete the account Shopify SKU settings"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteShopifySkuSettings","name":"Delete the account Shopify SKU settings","isWebhook":false,"pointer":"/paths/~1shopify-sku-settings/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete the account Shopify SKU settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/shopify-sku-settings","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","4XX"],"pointer":"/shopify-sku-settings","href":"shopify-sku-settings/deleteshopifyskusettings","openApiOperationId":"deleteShopifySkuSettings","summary":"Delete the account Shopify SKU settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1shopify-sku-settings/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shopify-sku-settings/deleteshopifyskusettings"}],"panels":[]}]},"httpPath":"/shopify-sku-settings"}],"content":{"contentType":"group","meta":{"name":"Shopify SKU Settings"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Shopify SKU Settings","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Coming soon; "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"mailto:help@dash.app"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contact us"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if you need access to this API endpoint."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/shopify-sku-settings","summary":"Get the account Shopify SKU settings","prefix":{"name":"get","color":"get"},"badges":[],"link":"/shopify-sku-settings/getshopifyskusettings","deprecated":false},{"title":"/shopify-sku-settings","summary":"Create or update the account Shopify SKU settings","prefix":{"name":"put","color":"put"},"badges":[],"link":"/shopify-sku-settings/putshopifyskusettings","deprecated":false},{"title":"/shopify-sku-settings","summary":"Delete the account Shopify SKU settings","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/shopify-sku-settings/deleteshopifyskusettings","deprecated":false}]}]}]}]}},{"type":"group","label":"Subscription","link":"/dash/openapi/subscription","routeSlug":"/dash/openapi/subscription","items":[{"label":"Get the account subscription","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/subscription/getsubscription","routeSlug":"/dash/openapi/subscription/getsubscription","metadata":{"seo":{"title":"Get the account subscription","description":"Get the Subscription associated with your account"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSubscription","name":"Get the account subscription","isWebhook":false,"pointer":"/paths/~1subscription/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get the account subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get the Subscription associated with your account\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/subscription","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","4XX"],"pointer":"/subscription","href":"subscription/getsubscription","openApiOperationId":"getSubscription","summary":"Get the account subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriptionWithPermittedActions"}},"schemaId":"components/schemas/SubscriptionWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1subscription/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SubscriptionWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriptionWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscription/getsubscription"}],"panels":[]}]},"httpPath":"/subscription"},{"label":"Delete the account subscription","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/subscription/deletesubscription","routeSlug":"/dash/openapi/subscription/deletesubscription","metadata":{"seo":{"title":"Delete the account subscription","description":"Delete the Subscription associated with your account"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteSubscription","name":"Delete the account subscription","isWebhook":false,"pointer":"/paths/~1subscription/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete the account subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete the Subscription associated with your account\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/subscription","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","4XX"],"pointer":"/subscription","href":"subscription/deletesubscription","openApiOperationId":"deleteSubscription","summary":"Delete the account subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1subscription/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscription/deletesubscription"}],"panels":[]}]},"httpPath":"/subscription"},{"label":"Get the subscription estimate","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/subscription/getsubscriptionestimate","routeSlug":"/dash/openapi/subscription/getsubscriptionestimate","metadata":{"seo":{"title":"Get the subscription estimate","description":"Get an estimate of the upcoming subscription based on current usage"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSubscriptionEstimate","name":"Get the subscription estimate","isWebhook":false,"pointer":"/paths/~1subscription-estimate/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get the subscription estimate","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get an estimate of the upcoming subscription based on current usage\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/subscription-estimate","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","4XX"],"pointer":"/subscription-estimate","href":"subscription/getsubscriptionestimate","openApiOperationId":"getSubscriptionEstimate","summary":"Get the subscription estimate"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreatedSubscriptionWithPermittedActions"}},"schemaId":"components/schemas/CreatedSubscriptionWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1subscription-estimate/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreatedSubscriptionWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreatedSubscriptionWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscription/getsubscriptionestimate"}],"panels":[]}]},"httpPath":"/subscription-estimate"},{"label":"Create a subscription intent","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/subscription/postsubscriptionintent","routeSlug":"/dash/openapi/subscription/postsubscriptionintent","metadata":{"seo":{"title":"Create a subscription intent","description":"Create a new Subscription Intent resource to indicate intent to subscribe to a paid plan"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postSubscriptionIntent","name":"Create a subscription intent","isWebhook":false,"pointer":"/paths/~1subscription-intents/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a subscription intent","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a new Subscription Intent resource to indicate intent to subscribe to a paid plan\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SubscriptionIntentRequest"}},"schemaId":"components/schemas/SubscriptionIntentRequest","pointer":"/paths/~1subscription-intents/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/subscription-intents","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SubscriptionIntentRequest"}},"responseCodes":["200","4XX"],"pointer":"/subscription-intents","href":"subscription/postsubscriptionintent","openApiOperationId":"postSubscriptionIntent","summary":"Create a subscription intent"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/SubscriptionIntentRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SubscriptionIntentRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriptionIntentWithPermittedActions"}},"schemaId":"components/schemas/SubscriptionIntentWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1subscription-intents/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SubscriptionIntentWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriptionIntentWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscription/postsubscriptionintent"}],"panels":[]}]},"httpPath":"/subscription-intents"},{"label":"Get a subscription intent","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/subscription/getsubscriptionintent","routeSlug":"/dash/openapi/subscription/getsubscriptionintent","metadata":{"seo":{"title":"Get a subscription intent","description":"Get a Subscription Intent resource"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSubscriptionIntent","name":"Get a subscription intent","isWebhook":false,"pointer":"/paths/~1subscription-intents~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a subscription intent","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a Subscription Intent resource\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_25","description":"The unique ID of the SubscriptionIntent","required":true}],"pointer":"/paths/~1subscription-intents~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/subscription-intents/{id}","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","4XX"],"pointer":"/subscription-intents/{id}","href":"subscription/getsubscriptionintent","openApiOperationId":"getSubscriptionIntent","summary":"Get a subscription intent"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriptionIntentWithPermittedActions"}},"schemaId":"components/schemas/SubscriptionIntentWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1subscription-intents~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SubscriptionIntentWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriptionIntentWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscription/getsubscriptionintent"}],"panels":[]}]},"httpPath":"/subscription-intents/{id}"},{"label":"Update a subscription intent","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/subscription/patchsubscriptionintent","routeSlug":"/dash/openapi/subscription/patchsubscriptionintent","metadata":{"seo":{"title":"Update a subscription intent","description":"Update a Subscription Intent resource"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchSubscriptionIntent","name":"Update a subscription intent","isWebhook":false,"pointer":"/paths/~1subscription-intents~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a subscription intent","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update a Subscription Intent resource\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_25","description":"The unique ID of the SubscriptionIntent","required":true}],"pointer":"/paths/~1subscription-intents~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SubscriptionIntentPatchRequest"}},"schemaId":"components/schemas/SubscriptionIntentPatchRequest","pointer":"/paths/~1subscription-intents~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/subscription-intents/{id}","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SubscriptionIntentPatchRequest"}},"responseCodes":["200","4XX"],"pointer":"/subscription-intents/{id}","href":"subscription/patchsubscriptionintent","openApiOperationId":"patchSubscriptionIntent","summary":"Update a subscription intent"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/SubscriptionIntentPatchRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SubscriptionIntentPatchRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriptionIntentWithPermittedActions"}},"schemaId":"components/schemas/SubscriptionIntentWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1subscription-intents~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SubscriptionIntentWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriptionIntentWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscription/patchsubscriptionintent"}],"panels":[]}]},"httpPath":"/subscription-intents/{id}"},{"label":"Get subscription usage","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/subscription/getsubscriptionusage","routeSlug":"/dash/openapi/subscription/getsubscriptionusage","metadata":{"seo":{"title":"Get subscription usage","description":"Get a summary of your subscription usage for the last six months."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSubscriptionUsage","name":"Get subscription usage","isWebhook":false,"pointer":"/paths/~1subscription-usage/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get subscription usage","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a summary of your subscription usage for the last six months.\n\nIf you are on a tiered subscription (Starting, Growing or Dashing), the download counts will be bucketed by calendar month. For example, the last counts will include all downloads this calendar month up to today.\n\nIf you are on the new value-based pricing (Startup, Small Team, Growing Brand or Established Brand), then the download counts are bucketed based on your billing month.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/subscription-usage","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","4XX"],"pointer":"/subscription-usage","href":"subscription/getsubscriptionusage","openApiOperationId":"getSubscriptionUsage","summary":"Get subscription usage"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriptionUsage"}},"schemaId":"components/schemas/SubscriptionUsage"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1subscription-usage/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SubscriptionUsage","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriptionUsage"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscription/getsubscriptionusage"}],"panels":[]}]},"httpPath":"/subscription-usage"}],"content":{"contentType":"group","meta":{"name":"Subscription"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Subscription","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Coming soon; "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"mailto:help@dash.app"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contact us"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if you need access to this API endpoint."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/subscription","summary":"Get the account subscription","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subscription/getsubscription","deprecated":false},{"title":"/subscription","summary":"Delete the account subscription","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/subscription/deletesubscription","deprecated":false},{"title":"/subscription-estimate","summary":"Get the subscription estimate","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subscription/getsubscriptionestimate","deprecated":false},{"title":"/subscription-intents","summary":"Create a subscription intent","prefix":{"name":"post","color":"post"},"badges":[],"link":"/subscription/postsubscriptionintent","deprecated":false},{"title":"/subscription-intents/{id}","summary":"Get a subscription intent","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subscription/getsubscriptionintent","deprecated":false},{"title":"/subscription-intents/{id}","summary":"Update a subscription intent","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/subscription/patchsubscriptionintent","deprecated":false},{"title":"/subscription-usage","summary":"Get subscription usage","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subscription/getsubscriptionusage","deprecated":false}]}]}]}]}},{"type":"group","label":"Text In Image Settings","link":"/dash/openapi/text-in-image-settings","routeSlug":"/dash/openapi/text-in-image-settings","items":[{"label":"Get the account text in image settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/text-in-image-settings/gettextinimagesettings","routeSlug":"/dash/openapi/text-in-image-settings/gettextinimagesettings","metadata":{"seo":{"title":"Get the account text in image settings","description":"Get the account text in image settings"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getTextInImageSettings","name":"Get the account text in image settings","isWebhook":false,"pointer":"/paths/~1text-in-image-settings/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get the account text in image settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/text-in-image-settings","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","4XX"],"pointer":"/text-in-image-settings","href":"text-in-image-settings/gettextinimagesettings","openApiOperationId":"getTextInImageSettings","summary":"Get the account text in image settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TextInImageSettingsWithPermittedActions"}},"schemaId":"components/schemas/TextInImageSettingsWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1text-in-image-settings/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TextInImageSettingsWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TextInImageSettingsWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/text-in-image-settings/gettextinimagesettings"}],"panels":[]}]},"httpPath":"/text-in-image-settings"},{"label":"Update the account text in image settings","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/text-in-image-settings/patchtextinimagesettings","routeSlug":"/dash/openapi/text-in-image-settings/patchtextinimagesettings","metadata":{"seo":{"title":"Update the account text in image settings","description":"Update the account text in image settings"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchTextInImageSettings","name":"Update the account text in image settings","isWebhook":false,"pointer":"/paths/~1text-in-image-settings/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update the account text in image settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TextInImageSettingsPatchRequest"}},"schemaId":"components/schemas/TextInImageSettingsPatchRequest","pointer":"/paths/~1text-in-image-settings/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/text-in-image-settings","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TextInImageSettingsPatchRequest"}},"responseCodes":["200","4XX"],"pointer":"/text-in-image-settings","href":"text-in-image-settings/patchtextinimagesettings","openApiOperationId":"patchTextInImageSettings","summary":"Update the account text in image settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/TextInImageSettingsPatchRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TextInImageSettingsPatchRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TextInImageSettingsWithPermittedActions"}},"schemaId":"components/schemas/TextInImageSettingsWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1text-in-image-settings/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TextInImageSettingsWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TextInImageSettingsWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/text-in-image-settings/patchtextinimagesettings"}],"panels":[]}]},"httpPath":"/text-in-image-settings"}],"content":{"contentType":"group","meta":{"name":"Text In Image Settings"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Text In Image Settings","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Coming soon; "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"mailto:help@dash.app"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contact us"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if you need access to this API endpoint."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/text-in-image-settings","summary":"Get the account text in image settings","prefix":{"name":"get","color":"get"},"badges":[],"link":"/text-in-image-settings/gettextinimagesettings","deprecated":false},{"title":"/text-in-image-settings","summary":"Update the account text in image settings","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/text-in-image-settings/patchtextinimagesettings","deprecated":false}]}]}]}]}},{"type":"group","label":"Terms and Conditions","link":"/dash/openapi/terms-and-conditions","routeSlug":"/dash/openapi/terms-and-conditions","items":[{"label":"Get account terms and conditions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/terms-and-conditions/getaccounttermsandconditions","routeSlug":"/dash/openapi/terms-and-conditions/getaccounttermsandconditions","metadata":{"seo":{"title":"Get account terms and conditions","description":"Get an AccountTermsAndConditions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAccountTermsAndConditions","name":"Get account terms and conditions","isWebhook":false,"pointer":"/paths/~1account-terms-and-conditions~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get account terms and conditions","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":"Get an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/terms-and-conditions/getaccounttermsandconditions"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AccountTermsAndConditions"},"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":"This endpoint is unauthenticated. Do not send a Bearer Token in the Authorization Header"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/terms-and-conditions/getaccounttermsandconditions"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AccountTermsAndConditions"},"children":[]}]}]}]}],"required":true}],"pointer":"/paths/~1account-terms-and-conditions~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/account-terms-and-conditions/{id}","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","4XX"],"pointer":"/account-terms-and-conditions/{id}","href":"terms-and-conditions/getaccounttermsandconditions","openApiOperationId":"getAccountTermsAndConditions","summary":"Get account terms and conditions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountTermsAndConditions"}},"schemaId":"components/schemas/AccountTermsAndConditions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1account-terms-and-conditions~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AccountTermsAndConditions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountTermsAndConditions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/terms-and-conditions/getaccounttermsandconditions"}],"panels":[]}]},"httpPath":"/account-terms-and-conditions/{id}"},{"label":"Delete account terms and conditions","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/terms-and-conditions/deleteaccounttermsandconditions","routeSlug":"/dash/openapi/terms-and-conditions/deleteaccounttermsandconditions","metadata":{"seo":{"title":"Delete account terms and conditions","description":"Delete an AccountTermsAndConditions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteAccountTermsAndConditions","name":"Delete account terms and conditions","isWebhook":false,"pointer":"/paths/~1account-terms-and-conditions~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete account terms and conditions","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":"Delete an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/terms-and-conditions/getaccounttermsandconditions"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AccountTermsAndConditions"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/terms-and-conditions/getaccounttermsandconditions"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AccountTermsAndConditions"},"children":[]}]}]}]}],"required":true}],"pointer":"/paths/~1account-terms-and-conditions~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/account-terms-and-conditions/{id}","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","4XX"],"pointer":"/account-terms-and-conditions/{id}","href":"terms-and-conditions/deleteaccounttermsandconditions","openApiOperationId":"deleteAccountTermsAndConditions","summary":"Delete account terms and conditions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1account-terms-and-conditions~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/terms-and-conditions/deleteaccounttermsandconditions"}],"panels":[]}]},"httpPath":"/account-terms-and-conditions/{id}"},{"label":"Create or update account terms and conditions","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/terms-and-conditions/putaccounttermsandconditions","routeSlug":"/dash/openapi/terms-and-conditions/putaccounttermsandconditions","metadata":{"seo":{"title":"Create or update account terms and conditions","description":"Create or update an AccountTermsAndConditions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"putAccountTermsAndConditions","name":"Create or update account terms and conditions","isWebhook":false,"pointer":"/paths/~1account-terms-and-conditions~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create or update account terms and conditions","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":"Create or update an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/terms-and-conditions/getaccounttermsandconditions"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AccountTermsAndConditions"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/terms-and-conditions/getaccounttermsandconditions"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AccountTermsAndConditions"},"children":[]}]}]}]}],"required":true}],"pointer":"/paths/~1account-terms-and-conditions~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AccountTermsAndConditionsRequest"}},"schemaId":"components/schemas/AccountTermsAndConditionsRequest","pointer":"/paths/~1account-terms-and-conditions~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/account-terms-and-conditions/{id}","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AccountTermsAndConditionsRequest"}},"responseCodes":["200","4XX"],"pointer":"/account-terms-and-conditions/{id}","href":"terms-and-conditions/putaccounttermsandconditions","openApiOperationId":"putAccountTermsAndConditions","summary":"Create or update account terms and conditions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/AccountTermsAndConditionsRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AccountTermsAndConditionsRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountTermsAndConditions"}},"schemaId":"components/schemas/AccountTermsAndConditions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1account-terms-and-conditions~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AccountTermsAndConditions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountTermsAndConditions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/terms-and-conditions/putaccounttermsandconditions"}],"panels":[]}]},"httpPath":"/account-terms-and-conditions/{id}"},{"label":"Get the account terms and conditions in effect","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/terms-and-conditions/getaccounttermsandconditionsineffect","routeSlug":"/dash/openapi/terms-and-conditions/getaccounttermsandconditionsineffect","metadata":{"seo":{"title":"Get the account terms and conditions in effect","description":"Get the latest AccountTermsAndConditions in effect"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAccountTermsAndConditionsInEffect","name":"Get the account terms and conditions in effect","isWebhook":false,"pointer":"/paths/~1account-terms-and-conditions-in-effect/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get the account terms and conditions in effect","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":"Get the latest "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/terms-and-conditions/getaccounttermsandconditions"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AccountTermsAndConditions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in effect"},"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":"This endpoint is unauthenticated. Do not send a Bearer Token in the Authorization Header"},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/account-terms-and-conditions-in-effect","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","4XX"],"pointer":"/account-terms-and-conditions-in-effect","href":"terms-and-conditions/getaccounttermsandconditionsineffect","openApiOperationId":"getAccountTermsAndConditionsInEffect","summary":"Get the account terms and conditions in effect"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountTermsAndConditions"}},"schemaId":"components/schemas/AccountTermsAndConditions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1account-terms-and-conditions-in-effect/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AccountTermsAndConditions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountTermsAndConditions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/terms-and-conditions/getaccounttermsandconditionsineffect"}],"panels":[]}]},"httpPath":"/account-terms-and-conditions-in-effect"}],"content":{"contentType":"group","meta":{"name":"Terms and Conditions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Terms and Conditions","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Coming soon; "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"mailto:help@dash.app"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contact us"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if you need access to this API endpoint."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/account-terms-and-conditions/{id}","summary":"Get account terms and conditions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/terms-and-conditions/getaccounttermsandconditions","deprecated":false},{"title":"/account-terms-and-conditions/{id}","summary":"Delete account terms and conditions","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/terms-and-conditions/deleteaccounttermsandconditions","deprecated":false},{"title":"/account-terms-and-conditions/{id}","summary":"Create or update account terms and conditions","prefix":{"name":"put","color":"put"},"badges":[],"link":"/terms-and-conditions/putaccounttermsandconditions","deprecated":false},{"title":"/account-terms-and-conditions-in-effect","summary":"Get the account terms and conditions in effect","prefix":{"name":"get","color":"get"},"badges":[],"link":"/terms-and-conditions/getaccounttermsandconditionsineffect","deprecated":false}]}]}]}]}},{"type":"group","label":"Theme","link":"/dash/openapi/theme","routeSlug":"/dash/openapi/theme","items":[{"label":"Get the account theme","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/theme/gettheme","routeSlug":"/dash/openapi/theme/gettheme","metadata":{"seo":{"title":"Get the account theme","description":"Get the account's Theme"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getTheme","name":"Get the account theme","isWebhook":false,"pointer":"/paths/~1context-types~1{contextType}~1contexts~1{contextId}~1theme/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get the account theme","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":"Get the account's "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Theme"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Theme"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"contextType","in":"path","schemaId":"schema_25","required":true},{"name":"contextId","in":"path","schemaId":"schema_25","required":true}],"pointer":"/paths/~1context-types~1{contextType}~1contexts~1{contextId}~1theme/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/context-types/{contextType}/contexts/{contextId}/theme","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"contextType","in":"path","required":true,"schemaId":"schema_25"},{"name":"contextId","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","4XX"],"pointer":"/context-types/{contextType}/contexts/{contextId}/theme","href":"theme/gettheme","openApiOperationId":"getTheme","summary":"Get the account theme"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ThemeWithPermittedActions"}},"schemaId":"components/schemas/ThemeWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1context-types~1{contextType}~1contexts~1{contextId}~1theme/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ThemeWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ThemeWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/theme/gettheme"}],"panels":[]}]},"httpPath":"/context-types/{contextType}/contexts/{contextId}/theme"},{"label":"Update the account theme","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/theme/patchtheme","routeSlug":"/dash/openapi/theme/patchtheme","metadata":{"seo":{"title":"Update the account theme","description":"Update the Theme of the account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchTheme","name":"Update the account theme","isWebhook":false,"pointer":"/paths/~1context-types~1{contextType}~1contexts~1{contextId}~1theme/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update the account theme","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":"Update the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Theme"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Theme"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the account."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"contextType","in":"path","schemaId":"schema_25","required":true},{"name":"contextId","in":"path","schemaId":"schema_25","required":true}],"pointer":"/paths/~1context-types~1{contextType}~1contexts~1{contextId}~1theme/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ThemePatchRequest"}},"schemaId":"components/schemas/ThemePatchRequest","pointer":"/paths/~1context-types~1{contextType}~1contexts~1{contextId}~1theme/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/context-types/{contextType}/contexts/{contextId}/theme","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"contextType","in":"path","required":true,"schemaId":"schema_25"},{"name":"contextId","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ThemePatchRequest"}},"responseCodes":["200","4XX"],"pointer":"/context-types/{contextType}/contexts/{contextId}/theme","href":"theme/patchtheme","openApiOperationId":"patchTheme","summary":"Update the account theme"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/ThemePatchRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ThemePatchRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ThemeWithPermittedActions"}},"schemaId":"components/schemas/ThemeWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1context-types~1{contextType}~1contexts~1{contextId}~1theme/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ThemeWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ThemeWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/theme/patchtheme"}],"panels":[]}]},"httpPath":"/context-types/{contextType}/contexts/{contextId}/theme"},{"label":"Upload a theme image","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/theme/postthemeimageupload","routeSlug":"/dash/openapi/theme/postthemeimageupload","metadata":{"seo":{"title":"Upload a theme image","description":"Post an upload object for one of the images in the account's Theme"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postThemeImageUpload","name":"Upload a theme image","isWebhook":false,"pointer":"/paths/~1context-types~1{contextType}~1contexts~1{contextId}~1theme-image-uploads/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload a theme 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":"Post an upload object for one of the images in the account's "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Theme"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Theme"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"contextType","in":"path","schemaId":"schema_25","required":true},{"name":"contextId","in":"path","schemaId":"schema_25","required":true}],"pointer":"/paths/~1context-types~1{contextType}~1contexts~1{contextId}~1theme-image-uploads/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ThemeImageUploadRequest"}},"schemaId":"components/schemas/ThemeImageUploadRequest","pointer":"/paths/~1context-types~1{contextType}~1contexts~1{contextId}~1theme-image-uploads/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/context-types/{contextType}/contexts/{contextId}/theme-image-uploads","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"contextType","in":"path","required":true,"schemaId":"schema_25"},{"name":"contextId","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ThemeImageUploadRequest"}},"responseCodes":["200","4XX"],"pointer":"/context-types/{contextType}/contexts/{contextId}/theme-image-uploads","href":"theme/postthemeimageupload","openApiOperationId":"postThemeImageUpload","summary":"Upload a theme image"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/ThemeImageUploadRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ThemeImageUploadRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FieldOptionImageUpload"}},"schemaId":"components/schemas/FieldOptionImageUpload"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1context-types~1{contextType}~1contexts~1{contextId}~1theme-image-uploads/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/FieldOptionImageUpload","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FieldOptionImageUpload"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/theme/postthemeimageupload"}],"panels":[]}]},"httpPath":"/context-types/{contextType}/contexts/{contextId}/theme-image-uploads"},{"label":"Search for account themes","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/theme/postthemesearch","routeSlug":"/dash/openapi/theme/postthemesearch","metadata":{"seo":{"title":"Search for account themes","description":"Create a new ThemeSearch. This can be used to search for a theme by subdomain."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postThemeSearch","name":"Search for account themes","isWebhook":false,"pointer":"/paths/~1theme-searches/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search for account themes","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":"Create a new "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/theme/postthemesearch"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ThemeSearch"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This can be used to search for a theme by subdomain."},"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":"This endpoint is unauthenticated. Do not send a Bearer Token in the Authorization Header"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ThemeSearchRequest"}},"schemaId":"components/schemas/ThemeSearchRequest","pointer":"/paths/~1theme-searches/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/theme-searches","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/ThemeSearchRequest"}},"responseCodes":["200","4XX"],"pointer":"/theme-searches","href":"theme/postthemesearch","openApiOperationId":"postThemeSearch","summary":"Search for account themes"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/ThemeSearchRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ThemeSearchRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ThemeSearch"}},"schemaId":"components/schemas/ThemeSearch"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1theme-searches/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ThemeSearch","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ThemeSearch"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/theme/postthemesearch"}],"panels":[]}]},"httpPath":"/theme-searches"},{"label":"Delete the account theme favicon","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/theme/deletethemefavicon","routeSlug":"/dash/openapi/theme/deletethemefavicon","metadata":{"seo":{"title":"Delete the account theme favicon","description":"Delete the favicon from the Theme"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteThemeFavicon","name":"Delete the account theme favicon","isWebhook":false,"pointer":"/paths/~1context-types~1{contextType}~1contexts~1{contextId}~1theme~1favicon/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete the account theme favicon","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":"Delete the favicon from the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Theme"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Theme"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"contextType","in":"path","schemaId":"schema_25","required":true},{"name":"contextId","in":"path","schemaId":"schema_25","required":true}],"pointer":"/paths/~1context-types~1{contextType}~1contexts~1{contextId}~1theme~1favicon/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/context-types/{contextType}/contexts/{contextId}/theme/favicon","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"contextType","in":"path","required":true,"schemaId":"schema_25"},{"name":"contextId","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","4XX"],"pointer":"/context-types/{contextType}/contexts/{contextId}/theme/favicon","href":"theme/deletethemefavicon","openApiOperationId":"deleteThemeFavicon","summary":"Delete the account theme favicon"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1context-types~1{contextType}~1contexts~1{contextId}~1theme~1favicon/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/theme/deletethemefavicon"}],"panels":[]}]},"httpPath":"/context-types/{contextType}/contexts/{contextId}/theme/favicon"},{"label":"Delete the account theme homepage image","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/theme/deletethemehomepageimage","routeSlug":"/dash/openapi/theme/deletethemehomepageimage","metadata":{"seo":{"title":"Delete the account theme homepage image","description":"Delete the homepage image from the Theme"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteThemeHomepageImage","name":"Delete the account theme homepage image","isWebhook":false,"pointer":"/paths/~1context-types~1{contextType}~1contexts~1{contextId}~1theme~1homepage-image/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete the account theme homepage 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":"Delete the homepage image from the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Theme"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Theme"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"contextType","in":"path","schemaId":"schema_25","required":true},{"name":"contextId","in":"path","schemaId":"schema_25","required":true}],"pointer":"/paths/~1context-types~1{contextType}~1contexts~1{contextId}~1theme~1homepage-image/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/context-types/{contextType}/contexts/{contextId}/theme/homepage-image","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"contextType","in":"path","required":true,"schemaId":"schema_25"},{"name":"contextId","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","4XX"],"pointer":"/context-types/{contextType}/contexts/{contextId}/theme/homepage-image","href":"theme/deletethemehomepageimage","openApiOperationId":"deleteThemeHomepageImage","summary":"Delete the account theme homepage image"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1context-types~1{contextType}~1contexts~1{contextId}~1theme~1homepage-image/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/theme/deletethemehomepageimage"}],"panels":[]}]},"httpPath":"/context-types/{contextType}/contexts/{contextId}/theme/homepage-image"},{"label":"Delete the account theme login image","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/theme/deletethemeloginimage","routeSlug":"/dash/openapi/theme/deletethemeloginimage","metadata":{"seo":{"title":"Delete the account theme login image","description":"Delete the login image from the Theme"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteThemeLoginImage","name":"Delete the account theme login image","isWebhook":false,"pointer":"/paths/~1context-types~1{contextType}~1contexts~1{contextId}~1theme~1login-image/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete the account theme login 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":"Delete the login image from the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Theme"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Theme"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"contextType","in":"path","schemaId":"schema_25","required":true},{"name":"contextId","in":"path","schemaId":"schema_25","required":true}],"pointer":"/paths/~1context-types~1{contextType}~1contexts~1{contextId}~1theme~1login-image/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/context-types/{contextType}/contexts/{contextId}/theme/login-image","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"contextType","in":"path","required":true,"schemaId":"schema_25"},{"name":"contextId","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","4XX"],"pointer":"/context-types/{contextType}/contexts/{contextId}/theme/login-image","href":"theme/deletethemeloginimage","openApiOperationId":"deleteThemeLoginImage","summary":"Delete the account theme login image"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1context-types~1{contextType}~1contexts~1{contextId}~1theme~1login-image/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/theme/deletethemeloginimage"}],"panels":[]}]},"httpPath":"/context-types/{contextType}/contexts/{contextId}/theme/login-image"},{"label":"Delete the account theme logo","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/theme/deletethemelogo","routeSlug":"/dash/openapi/theme/deletethemelogo","metadata":{"seo":{"title":"Delete the account theme logo","description":"Delete the logo from the Theme"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteThemeLogo","name":"Delete the account theme logo","isWebhook":false,"pointer":"/paths/~1context-types~1{contextType}~1contexts~1{contextId}~1theme~1logo/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete the account theme logo","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":"Delete the logo from the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Theme"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Theme"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"contextType","in":"path","schemaId":"schema_25","required":true},{"name":"contextId","in":"path","schemaId":"schema_25","required":true}],"pointer":"/paths/~1context-types~1{contextType}~1contexts~1{contextId}~1theme~1logo/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/context-types/{contextType}/contexts/{contextId}/theme/logo","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"contextType","in":"path","required":true,"schemaId":"schema_25"},{"name":"contextId","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","4XX"],"pointer":"/context-types/{contextType}/contexts/{contextId}/theme/logo","href":"theme/deletethemelogo","openApiOperationId":"deleteThemeLogo","summary":"Delete the account theme logo"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1context-types~1{contextType}~1contexts~1{contextId}~1theme~1logo/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/theme/deletethemelogo"}],"panels":[]}]},"httpPath":"/context-types/{contextType}/contexts/{contextId}/theme/logo"},{"label":"Get the account theme","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/theme/getthemedeprecated","routeSlug":"/dash/openapi/theme/getthemedeprecated","metadata":{"seo":{"title":"Get the account theme","description":"Get the account's Theme"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getThemeDeprecated","name":"Get the account theme","isWebhook":false,"pointer":"/paths/~1theme/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get the account theme","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":"Get the account's "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Theme"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Theme"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/theme","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","4XX"],"pointer":"/theme","href":"theme/getthemedeprecated","openApiOperationId":"getThemeDeprecated","summary":"Get the account theme"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ThemeWithPermittedActions"}},"schemaId":"components/schemas/ThemeWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1theme/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ThemeWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ThemeWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/theme/getthemedeprecated"}],"panels":[]}]},"httpPath":"/theme"},{"label":"Update the account theme","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/theme/patchthemedeprecated","routeSlug":"/dash/openapi/theme/patchthemedeprecated","metadata":{"seo":{"title":"Update the account theme","description":"Update the Theme of the account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchThemeDeprecated","name":"Update the account theme","isWebhook":false,"pointer":"/paths/~1theme/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update the account theme","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":"Update the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Theme"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Theme"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the account."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ThemePatchRequest"}},"schemaId":"components/schemas/ThemePatchRequest","pointer":"/paths/~1theme/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/theme","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ThemePatchRequest"}},"responseCodes":["200","4XX"],"pointer":"/theme","href":"theme/patchthemedeprecated","openApiOperationId":"patchThemeDeprecated","summary":"Update the account theme"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/ThemePatchRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ThemePatchRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ThemeWithPermittedActions"}},"schemaId":"components/schemas/ThemeWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1theme/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ThemeWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ThemeWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/theme/patchthemedeprecated"}],"panels":[]}]},"httpPath":"/theme"},{"label":"Upload a theme image","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/theme/postthemeimageuploaddeprecated","routeSlug":"/dash/openapi/theme/postthemeimageuploaddeprecated","metadata":{"seo":{"title":"Upload a theme image","description":"Post an upload object for one of the images in the account's Theme"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postThemeImageUploadDeprecated","name":"Upload a theme image","isWebhook":false,"pointer":"/paths/~1theme-image-uploads/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload a theme 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":"Post an upload object for one of the images in the account's "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Theme"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Theme"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ThemeImageUploadRequest"}},"schemaId":"components/schemas/ThemeImageUploadRequest","pointer":"/paths/~1theme-image-uploads/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/theme-image-uploads","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ThemeImageUploadRequest"}},"responseCodes":["200","4XX"],"pointer":"/theme-image-uploads","href":"theme/postthemeimageuploaddeprecated","openApiOperationId":"postThemeImageUploadDeprecated","summary":"Upload a theme image"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/ThemeImageUploadRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ThemeImageUploadRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FieldOptionImageUpload"}},"schemaId":"components/schemas/FieldOptionImageUpload"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1theme-image-uploads/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/FieldOptionImageUpload","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FieldOptionImageUpload"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/theme/postthemeimageuploaddeprecated"}],"panels":[]}]},"httpPath":"/theme-image-uploads"},{"label":"Delete the account theme favicon","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/theme/deletethemefavicondeprecated","routeSlug":"/dash/openapi/theme/deletethemefavicondeprecated","metadata":{"seo":{"title":"Delete the account theme favicon","description":"Delete the favicon from the Theme"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteThemeFaviconDeprecated","name":"Delete the account theme favicon","isWebhook":false,"pointer":"/paths/~1theme~1favicon/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete the account theme favicon","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":"Delete the favicon from the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Theme"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Theme"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/theme/favicon","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","4XX"],"pointer":"/theme/favicon","href":"theme/deletethemefavicondeprecated","openApiOperationId":"deleteThemeFaviconDeprecated","summary":"Delete the account theme favicon"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1theme~1favicon/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/theme/deletethemefavicondeprecated"}],"panels":[]}]},"httpPath":"/theme/favicon"},{"label":"Delete the account theme homepage image","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/theme/deletethemehomepageimagedeprecated","routeSlug":"/dash/openapi/theme/deletethemehomepageimagedeprecated","metadata":{"seo":{"title":"Delete the account theme homepage image","description":"Delete the homepage image from the Theme"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteThemeHomepageImageDeprecated","name":"Delete the account theme homepage image","isWebhook":false,"pointer":"/paths/~1theme~1homepage-image/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete the account theme homepage 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":"Delete the homepage image from the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Theme"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Theme"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/theme/homepage-image","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","4XX"],"pointer":"/theme/homepage-image","href":"theme/deletethemehomepageimagedeprecated","openApiOperationId":"deleteThemeHomepageImageDeprecated","summary":"Delete the account theme homepage image"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1theme~1homepage-image/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/theme/deletethemehomepageimagedeprecated"}],"panels":[]}]},"httpPath":"/theme/homepage-image"},{"label":"Delete the account theme login image","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/theme/deletethemeloginimagedeprecated","routeSlug":"/dash/openapi/theme/deletethemeloginimagedeprecated","metadata":{"seo":{"title":"Delete the account theme login image","description":"Delete the login image from the Theme"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteThemeLoginImageDeprecated","name":"Delete the account theme login image","isWebhook":false,"pointer":"/paths/~1theme~1login-image/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete the account theme login 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":"Delete the login image from the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Theme"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Theme"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/theme/login-image","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","4XX"],"pointer":"/theme/login-image","href":"theme/deletethemeloginimagedeprecated","openApiOperationId":"deleteThemeLoginImageDeprecated","summary":"Delete the account theme login image"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1theme~1login-image/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/theme/deletethemeloginimagedeprecated"}],"panels":[]}]},"httpPath":"/theme/login-image"},{"label":"Delete the account theme logo","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/theme/deletethemelogodeprecated","routeSlug":"/dash/openapi/theme/deletethemelogodeprecated","metadata":{"seo":{"title":"Delete the account theme logo","description":"Delete the logo from the Theme"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteThemeLogoDeprecated","name":"Delete the account theme logo","isWebhook":false,"pointer":"/paths/~1theme~1logo/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete the account theme logo","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":"Delete the logo from the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Theme"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Theme"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/theme/logo","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","4XX"],"pointer":"/theme/logo","href":"theme/deletethemelogodeprecated","openApiOperationId":"deleteThemeLogoDeprecated","summary":"Delete the account theme logo"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1theme~1logo/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/theme/deletethemelogodeprecated"}],"panels":[]}]},"httpPath":"/theme/logo"}],"content":{"contentType":"group","meta":{"name":"Theme"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Theme","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Coming soon; "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"mailto:help@dash.app"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contact us"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if you need access to this API endpoint."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/context-types/{contextType}/contexts/{contextId}/theme","summary":"Get the account theme","prefix":{"name":"get","color":"get"},"badges":[],"link":"/theme/gettheme","deprecated":false},{"title":"/context-types/{contextType}/contexts/{contextId}/theme","summary":"Update the account theme","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/theme/patchtheme","deprecated":false},{"title":"/context-types/{contextType}/contexts/{contextId}/theme-image-uploads","summary":"Upload a theme image","prefix":{"name":"post","color":"post"},"badges":[],"link":"/theme/postthemeimageupload","deprecated":false},{"title":"/theme-searches","summary":"Search for account themes","prefix":{"name":"post","color":"post"},"badges":[],"link":"/theme/postthemesearch","deprecated":false},{"title":"/context-types/{contextType}/contexts/{contextId}/theme/favicon","summary":"Delete the account theme favicon","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/theme/deletethemefavicon","deprecated":false},{"title":"/context-types/{contextType}/contexts/{contextId}/theme/homepage-image","summary":"Delete the account theme homepage image","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/theme/deletethemehomepageimage","deprecated":false},{"title":"/context-types/{contextType}/contexts/{contextId}/theme/login-image","summary":"Delete the account theme login image","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/theme/deletethemeloginimage","deprecated":false},{"title":"/context-types/{contextType}/contexts/{contextId}/theme/logo","summary":"Delete the account theme logo","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/theme/deletethemelogo","deprecated":false},{"title":"/theme","summary":"Get the account theme","prefix":{"name":"get","color":"get"},"badges":[],"link":"/theme/getthemedeprecated","deprecated":false},{"title":"/theme","summary":"Update the account theme","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/theme/patchthemedeprecated","deprecated":false},{"title":"/theme-image-uploads","summary":"Upload a theme image","prefix":{"name":"post","color":"post"},"badges":[],"link":"/theme/postthemeimageuploaddeprecated","deprecated":false},{"title":"/theme/favicon","summary":"Delete the account theme favicon","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/theme/deletethemefavicondeprecated","deprecated":false},{"title":"/theme/homepage-image","summary":"Delete the account theme homepage image","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/theme/deletethemehomepageimagedeprecated","deprecated":false},{"title":"/theme/login-image","summary":"Delete the account theme login image","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/theme/deletethemeloginimagedeprecated","deprecated":false},{"title":"/theme/logo","summary":"Delete the account theme logo","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/theme/deletethemelogodeprecated","deprecated":false}]}]}]}]}},{"type":"separator","label":"AI Image Generations","content":null},{"type":"group","label":"AI Image Generations","link":"/dash/openapi/ai-image-generations","routeSlug":"/dash/openapi/ai-image-generations","items":[{"label":"Generate an AI Image","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/ai-image-generations/postaiimagegenerations","routeSlug":"/dash/openapi/ai-image-generations/postaiimagegenerations","metadata":{"seo":{"title":"Generate an AI Image","description":"Generate an AI Image through an API for downloading or adding to Dash."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postAiImageGenerations","name":"Generate an AI Image","isWebhook":false,"pointer":"/paths/~1ai-image-generations/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Generate an AI Image","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Generate an AI Image through an API for downloading or adding to Dash.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AiImageGenerationsRequest"}},"schemaId":"components/schemas/AiImageGenerationsRequest","pointer":"/paths/~1ai-image-generations/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/ai-image-generations","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AiImageGenerationsRequest"}},"responseCodes":["200","4XX"],"pointer":"/ai-image-generations","href":"ai-image-generations/postaiimagegenerations","openApiOperationId":"postAiImageGenerations","summary":"Generate an AI Image"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/AiImageGenerationsRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AiImageGenerationsRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AiImageGenerationsResponse"}},"schemaId":"components/schemas/AiImageGenerationsResponse"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1ai-image-generations/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AiImageGenerationsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AiImageGenerationsResponse"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ai-image-generations/postaiimagegenerations"}],"panels":[]}]},"httpPath":"/ai-image-generations"}],"content":{"contentType":"group","meta":{"name":"AI Image Generations"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"AI Image Generations","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Coming soon; "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"mailto:help@dash.app"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contact us"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if you need access to this API endpoint."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/ai-image-generations","summary":"Generate an AI Image","prefix":{"name":"post","color":"post"},"badges":[],"link":"/ai-image-generations/postaiimagegenerations","deprecated":false}]}]}]}]}},{"type":"group","label":"Reference Image Uploads","link":"/dash/openapi/reference-image-uploads","routeSlug":"/dash/openapi/reference-image-uploads","items":[{"label":"Upload a reference image","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/reference-image-uploads/postreferenceimageuploads","routeSlug":"/dash/openapi/reference-image-uploads/postreferenceimageuploads","metadata":{"seo":{"title":"Upload a reference image","description":"Generate an S3 bucket key and url for uploading a reference image to for generating an AI Image."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postReferenceImageUploads","name":"Upload a reference image","isWebhook":false,"pointer":"/paths/~1reference-image-uploads/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload a reference image","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Generate an S3 bucket key and url for uploading a reference image to for generating an AI Image.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/reference-image-uploads","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","4XX"],"pointer":"/reference-image-uploads","href":"reference-image-uploads/postreferenceimageuploads","openApiOperationId":"postReferenceImageUploads","summary":"Upload a reference image"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReferenceImageUploadsResponse"}},"schemaId":"components/schemas/ReferenceImageUploadsResponse"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1reference-image-uploads/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ReferenceImageUploadsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReferenceImageUploadsResponse"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reference-image-uploads/postreferenceimageuploads"}],"panels":[]}]},"httpPath":"/reference-image-uploads"}],"content":{"contentType":"group","meta":{"name":"Reference Image Uploads"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reference Image Uploads","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/reference-image-uploads","summary":"Upload a reference image","prefix":{"name":"post","color":"post"},"badges":[],"link":"/reference-image-uploads/postreferenceimageuploads","deprecated":false}]}]}]}]}},{"type":"separator","label":"Asset","content":null},{"type":"group","label":"Assets","link":"/dash/openapi/assets","routeSlug":"/dash/openapi/assets","items":[{"type":"link","label":"Searching","link":"/dash/openapi/assets/searching","routeSlug":"/dash/openapi/assets/searching","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Searching"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"assets/searching"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Searching"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Searching allows you to find "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources in your Dash matching specific criteria."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Criteria can be constructed based on direct comparison or pattern matching of fields, where fields are either "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset.metadata.values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or certain fixed "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" properties."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The fixed "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"KEYWORDS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field can be used for a general purpose search as it will search across all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset.metadata.values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and fixed "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" properties."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For searches involving "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources where "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field.hasFixedOptions = true"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" a search using either the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption.id"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption.name"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will match."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Any "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" which is assigned an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption.id"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value for a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource where "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field.hierarchical = true"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" implicitly has the values of any parent "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources too."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As such, any search using the parents "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption.id"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption.name"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will match the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"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":"e.g. Given the hierarchical "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" structure "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Grandparent / Parent / Child"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" assigned the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption.id"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Child"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"  will also be returned in searches for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Parent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Grandparent"},"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 logical operators "},"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":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NOT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are provided to support complex queries based on multiple fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A list of sorts can also be provided to control the order in the which the results are returned."},"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":"action"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property of a search, which defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SEARCH_FOR_VIEW"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", specifies the context in which the search is being run. For example if you only want to return "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources that the search "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Users"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has permission to delete then set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"action"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SEARCH_FOR_DELETE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"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":"By default, searches will only returns results where "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset.lifecycleStatus.state = 'LIVE'"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you require search results to contain results with other state values, this needs to be explicitly included in the criteria."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Two kinds of search are possible, a standard "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/postassetsearch"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetSearch"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/postassetscrollsearch"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetScrollSearch"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":".`"},"children":[]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Lifecycle","link":"/dash/openapi/assets/lifecycle","routeSlug":"/dash/openapi/assets/lifecycle","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Lifecycle"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"assets/lifecycle"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lifecycle"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dash provides a simple lifecycle for "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources to facilitate review and approval before they are accessible to other users, and also keep them "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BINNED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" after deletion so they can be retrieved."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The lifecycle has four states"},"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":"STAGED"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PENDING_APPROVAL"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LIVE"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BINNED"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Depending on the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset.lifecycleStatus.state"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources will only be visible to certain users."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources begin in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STAGED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"While in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STAGED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources are only visible to the user who created the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and users where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User.isAdmin = true"},"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":"A "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Users"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with permission to create new "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources may not have the permission to move it to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"While in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING_APPROVAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources are only visible to users where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User.isAdmin = true"},"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":"Once in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources visibility is defined by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UserGroup"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permissions (currently only configurable via the Dash frontend, not via the API)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Users"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can change the state of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Assets"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BINNED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BINNED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be restored to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Asset Files","link":"/dash/openapi/assets/asset-files","routeSlug":"/dash/openapi/assets/asset-files","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Asset Files"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"assets/asset-files"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Asset Files"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/getassetfiles"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetFile"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" describes a version of a file for an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"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":"Properties describe details of the file such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mediaType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dimensions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (for images and videos)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"previewUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" provides a means to access previews of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/getassetfiles"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetFile"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The current "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/getassetfiles"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetFile"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is returned with the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource."},"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":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/getassetfiles"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetFile.id"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be provided when creating an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Asset-Downloads"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetDownload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to download a specific "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/getassetfiles"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetFile"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"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":"An "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/postassetupload"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetUpload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource is created when you want to upload a file to an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"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":"Upon completion a new "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/getassetfiles"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetFile"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is created and will subsequently be returned in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset.currentAssetFile"},"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":"You can use "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/getassetfiles"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET Asset Files"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to retrieve the all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/getassetfiles"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetFile"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources for an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"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":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/postassetupload"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetUpload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource defines one or more URLs to which parts of the file should be PUT to."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Below is an example CURL PUT request that could be used to upload a local file part to an upload part URL taken from an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/postassetupload"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetUpload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl --request PUT '<UPLOAD_PART_URL>' \\\n--header 'Content-Length: <SIZE_OF_PART>' \\\n--header 'Content-Type: <FILE_CONTENT_TYPE>' \\\n--data '@<PATH_TO_FILE_PART>'\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl --request PUT '<UPLOAD_PART_URL>' \\\n--header 'Content-Length: <SIZE_OF_PART>' \\\n--header 'Content-Type: <FILE_CONTENT_TYPE>' \\\n--data '@<PATH_TO_FILE_PART>'\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The upload is then completed by sending a list of the eTags returned from each of these PUTs to "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/postassetuploadCompletion"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetUploadComplete"},"children":[]}]}]}]}]}],"panels":[]}]}},{"label":"Get an asset.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/assets/getasset","routeSlug":"/dash/openapi/assets/getasset","metadata":{"seo":{"title":"Get an asset.","description":"Get an Asset"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAsset","name":"Get an asset.","isWebhook":false,"pointer":"/paths/~1assets~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get an asset.","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":"Get an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]}]}]}],"required":true}],"pointer":"/paths/~1assets~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/assets/{id}","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","4XX"],"pointer":"/assets/{id}","href":"assets/getasset","openApiOperationId":"getAsset","summary":"Get an asset."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AssetWithPermittedActions"}},"schemaId":"components/schemas/AssetWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1assets~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AssetWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AssetWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/assets/getasset"}],"panels":[]}]},"httpPath":"/assets/{id}"},{"label":"Delete an asset","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/assets/deleteasset","routeSlug":"/dash/openapi/assets/deleteasset","metadata":{"seo":{"title":"Delete an asset","description":"Delete an Asset. All associated AssetFile resources will also be deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteAsset","name":"Delete an asset","isWebhook":false,"pointer":"/paths/~1assets~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an asset","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":"Delete an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". All associated "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/getassetfiles"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetFile"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources will also be deleted."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]}]}]}],"required":true}],"pointer":"/paths/~1assets~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/assets/{id}","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","4XX"],"pointer":"/assets/{id}","href":"assets/deleteasset","openApiOperationId":"deleteAsset","summary":"Delete an asset"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1assets~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/assets/deleteasset"}],"panels":[]}]},"httpPath":"/assets/{id}"},{"label":"Update an asset","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/assets/patchasset","routeSlug":"/dash/openapi/assets/patchasset","metadata":{"seo":{"title":"Update an asset","description":"Patch an Asset"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchAsset","name":"Update an asset","isWebhook":false,"pointer":"/paths/~1assets~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an asset","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":"Patch an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]}]}]}],"required":true}],"pointer":"/paths/~1assets~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AssetPatchRequest"}},"schemaId":"components/schemas/AssetPatchRequest","pointer":"/paths/~1assets~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/assets/{id}","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AssetPatchRequest"}},"responseCodes":["204","4XX"],"pointer":"/assets/{id}","href":"assets/patchasset","openApiOperationId":"patchAsset","summary":"Update an asset"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/AssetPatchRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AssetPatchRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1assets~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/assets/patchasset"}],"panels":[]}]},"httpPath":"/assets/{id}"},{"label":"Create some new assets","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/assets/postassetscreations","routeSlug":"/dash/openapi/assets/postassetscreations","metadata":{"seo":{"title":"Create some new assets","description":"Create a specified number of new Assets without files.  AssetUploads can be done separately."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postAssetsCreations","name":"Create some new assets","isWebhook":false,"pointer":"/paths/~1assets-creations/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create some new assets","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":"Create a specified number of new "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"s without files.  "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/postassetuploadBatchJobs"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetUpload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"s can be done separately."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AssetsCreationRequest"}},"schemaId":"components/schemas/AssetsCreationRequest","pointer":"/paths/~1assets-creations/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/assets-creations","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AssetsCreationRequest"}},"responseCodes":["200","4XX"],"pointer":"/assets-creations","href":"assets/postassetscreations","openApiOperationId":"postAssetsCreations","summary":"Create some new assets"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/AssetsCreationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AssetsCreationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AssetsCreationWithPermittedActions"}},"schemaId":"components/schemas/AssetsCreationWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1assets-creations/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AssetsCreationWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AssetsCreationWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/assets/postassetscreations"}],"panels":[]}]},"httpPath":"/assets-creations"},{"label":"Create assets and upload files","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/assets/postassetanduploadbatchjob","routeSlug":"/dash/openapi/assets/postassetanduploadbatchjob","metadata":{"seo":{"title":"Create assets and upload files","description":"An AssetAndUploadBatchJob should be created when you want to create multiple Asset resources and also create an AssetUpload for each of them."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postAssetAndUploadBatchJob","name":"Create assets and upload files","isWebhook":false,"pointer":"/paths/~1asset-and-upload-batch-jobs/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create assets and upload 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":"An "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/postassetanduploadbatchjob"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetAndUploadBatchJob"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" should be created when you want to create multiple "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources and also create an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/postassetupload"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetUpload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for each of them."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each asset can be uploaded in a single part or in multiple parts. If the filesize is less than 5MiB then it must be uploaded in a single part. If the filesize is greater than 5GiB then it must be uploaded in multiple parts, each smaller than 5GiB."},"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":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/postassetupload"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetUpload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources in the completed job should then be used to upload the files for each and asset and complete each upload."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources have been created and files uploaded to them they will still be in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset.lifecycleStatus.state = 'STAGED'"},"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":"To send them for approval or put them live see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Asset-Lifecycle"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Asset Lifecycle"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AssetAndUploadBatchRequest"}},"schemaId":"components/schemas/AssetAndUploadBatchRequest","pointer":"/paths/~1asset-and-upload-batch-jobs/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/asset-and-upload-batch-jobs","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AssetAndUploadBatchRequest"}},"responseCodes":["200","4XX"],"pointer":"/asset-and-upload-batch-jobs","href":"assets/postassetanduploadbatchjob","openApiOperationId":"postAssetAndUploadBatchJob","summary":"Create assets and upload files"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/AssetAndUploadBatchRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AssetAndUploadBatchRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AssetAndUploadBatchJob"}},"schemaId":"components/schemas/AssetAndUploadBatchJob"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1asset-and-upload-batch-jobs/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AssetAndUploadBatchJob","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AssetAndUploadBatchJob"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/assets/postassetanduploadbatchjob"}],"panels":[]}]},"httpPath":"/asset-and-upload-batch-jobs"},{"label":"Get the status of creating assets and uploading files","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/assets/getassetanduploadbatchjob","routeSlug":"/dash/openapi/assets/getassetanduploadbatchjob","metadata":{"seo":{"title":"Get the status of creating assets and uploading files","description":"Get the status and eventual result of an AssetAndUploadBatchJob"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAssetAndUploadBatchJob","name":"Get the status of creating assets and uploading files","isWebhook":false,"pointer":"/paths/~1asset-and-upload-batch-jobs~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get the status of creating assets and uploading 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":"Get the status and eventual result of an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/postassetanduploadbatchjob"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetAndUploadBatchJob"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/postassetanduploadbatchjob"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetAndUploadBatchJob"},"children":[]}]}]}]}],"required":true}],"pointer":"/paths/~1asset-and-upload-batch-jobs~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/asset-and-upload-batch-jobs/{id}","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","4XX"],"pointer":"/asset-and-upload-batch-jobs/{id}","href":"assets/getassetanduploadbatchjob","openApiOperationId":"getAssetAndUploadBatchJob","summary":"Get the status of creating assets and uploading files"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AssetAndUploadBatchJob","exampleIds":["paths/~1asset-and-upload-batch-jobs~1{id}/get/responses/200/content/application~1json/examples/Completed"]}},"schemaId":"components/schemas/AssetAndUploadBatchJob","exampleIds":["paths/~1asset-and-upload-batch-jobs~1{id}/get/responses/200/content/application~1json/examples/Completed"]},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1asset-and-upload-batch-jobs~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AssetAndUploadBatchJob","exampleIds":["paths/~1asset-and-upload-batch-jobs~1{id}/get/responses/200/content/application~1json/examples/Completed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AssetAndUploadBatchJob","exampleIds":["paths/~1asset-and-upload-batch-jobs~1{id}/get/responses/200/content/application~1json/examples/Completed"]}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/assets/getassetanduploadbatchjob"}],"panels":[]}]},"httpPath":"/asset-and-upload-batch-jobs/{id}"},{"label":"Upload an asset file","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/assets/postassetupload","routeSlug":"/dash/openapi/assets/postassetupload","metadata":{"seo":{"title":"Upload an asset file","description":"Create a new AssetUpload resource for an existing Asset."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postAssetUpload","name":"Upload an asset file","isWebhook":false,"pointer":"/paths/~1asset-uploads/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload an asset 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":"Create a new "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/postassetupload"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetUpload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource for an existing "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AssetUploadRequest"}},"schemaId":"components/schemas/AssetUploadRequest","pointer":"/paths/~1asset-uploads/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/asset-uploads","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AssetUploadRequest"}},"responseCodes":["200","4XX"],"pointer":"/asset-uploads","href":"assets/postassetupload","openApiOperationId":"postAssetUpload","summary":"Upload an asset file"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/AssetUploadRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AssetUploadRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AssetAndUploadWithPermittedActions"}},"schemaId":"components/schemas/AssetAndUploadWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1asset-uploads/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AssetAndUploadWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AssetAndUploadWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/assets/postassetupload"}],"panels":[]}]},"httpPath":"/asset-uploads"},{"label":"Upload files to assets","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/assets/postassetuploadbatchjob","routeSlug":"/dash/openapi/assets/postassetuploadbatchjob","metadata":{"seo":{"title":"Upload files to assets","description":"An AssetUploadBatchJob should be created when you want to create an AssetUpload for multiple assets."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postAssetUploadBatchJob","name":"Upload files to assets","isWebhook":false,"pointer":"/paths/~1asset-upload-batch-jobs/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload files to assets","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":"An "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/postassetuploadBatchJob"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetUploadBatchJob"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" should be created when you want to create an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/postassetupload"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetUpload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for multiple assets."},"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":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/postassetupload"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetUpload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources in the completed job should then be used to upload the files for each and asset and complete each upload."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After the files have been uploaded to the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"s they will still be in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset.lifecycleStatus.state = 'STAGED'"},"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":"To send them for approval or put them live see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Asset-Lifecycle"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Asset Lifecycle"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AssetUploadBatchRequest"}},"schemaId":"components/schemas/AssetUploadBatchRequest","pointer":"/paths/~1asset-upload-batch-jobs/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/asset-upload-batch-jobs","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AssetUploadBatchRequest"}},"responseCodes":["200","4XX"],"pointer":"/asset-upload-batch-jobs","href":"assets/postassetuploadbatchjob","openApiOperationId":"postAssetUploadBatchJob","summary":"Upload files to assets"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/AssetUploadBatchRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AssetUploadBatchRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AssetAndUploadBatchJob"}},"schemaId":"components/schemas/AssetAndUploadBatchJob"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1asset-upload-batch-jobs/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AssetAndUploadBatchJob","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AssetAndUploadBatchJob"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/assets/postassetuploadbatchjob"}],"panels":[]}]},"httpPath":"/asset-upload-batch-jobs"},{"label":"Get the status of uploading files","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/assets/getassetuploadbatchjob","routeSlug":"/dash/openapi/assets/getassetuploadbatchjob","metadata":{"seo":{"title":"Get the status of uploading files","description":"Get the status and eventual result of an AssetUploadBatchJob"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAssetUploadBatchJob","name":"Get the status of uploading files","isWebhook":false,"pointer":"/paths/~1asset-upload-batch-jobs~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get the status of uploading 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":"Get the status and eventual result of an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/postassetuploadBatchJob"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetUploadBatchJob"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/postassetuploadBatchJob"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetUploadBatchJob"},"children":[]}]}]}]}],"required":true}],"pointer":"/paths/~1asset-upload-batch-jobs~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/asset-upload-batch-jobs/{id}","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","4XX"],"pointer":"/asset-upload-batch-jobs/{id}","href":"assets/getassetuploadbatchjob","openApiOperationId":"getAssetUploadBatchJob","summary":"Get the status of uploading files"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AssetAndUploadBatchJob","exampleIds":["paths/~1asset-upload-batch-jobs~1{id}/get/responses/200/content/application~1json/examples/Completed"]}},"schemaId":"components/schemas/AssetAndUploadBatchJob","exampleIds":["paths/~1asset-upload-batch-jobs~1{id}/get/responses/200/content/application~1json/examples/Completed"]},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1asset-upload-batch-jobs~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AssetAndUploadBatchJob","exampleIds":["paths/~1asset-upload-batch-jobs~1{id}/get/responses/200/content/application~1json/examples/Completed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AssetAndUploadBatchJob","exampleIds":["paths/~1asset-upload-batch-jobs~1{id}/get/responses/200/content/application~1json/examples/Completed"]}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/assets/getassetuploadbatchjob"}],"panels":[]}]},"httpPath":"/asset-upload-batch-jobs/{id}"},{"label":"Complete an asset file upload","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/assets/postassetuploadcompletion","routeSlug":"/dash/openapi/assets/postassetuploadcompletion","metadata":{"seo":{"title":"Complete an asset file upload","description":"After an AssetUpload has been created and each part of the file data has been PUT to the relavant URL the eTag from each PUT must be sent to indicate the upload is complete."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postAssetUploadCompletion","name":"Complete an asset file upload","isWebhook":false,"pointer":"/paths/~1asset-upload-completions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Complete an asset file upload","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":"After an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/postassetupload"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetUpload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has been created and each part of the file data has been "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PUT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to the relavant URL the eTag from each "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PUT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be sent to indicate the upload is complete."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AssetUploadCompletionRequest","exampleIds":["paths/~1asset-upload-completions/post/requestBody/content/application~1json/examples/Complete 3 parts"]}},"schemaId":"components/schemas/AssetUploadCompletionRequest","exampleIds":["paths/~1asset-upload-completions/post/requestBody/content/application~1json/examples/Complete 3 parts"],"pointer":"/paths/~1asset-upload-completions/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/asset-upload-completions","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AssetUploadCompletionRequest","exampleIds":["paths/~1asset-upload-completions/post/requestBody/content/application~1json/examples/Complete 3 parts"]}},"responseCodes":["200","4XX"],"pointer":"/asset-upload-completions","href":"assets/postassetuploadcompletion","openApiOperationId":"postAssetUploadCompletion","summary":"Complete an asset file upload"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/AssetUploadCompletionRequest","exampleIds":["paths/~1asset-upload-completions/post/requestBody/content/application~1json/examples/Complete 3 parts"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AssetUploadCompletionRequest","exampleIds":["paths/~1asset-upload-completions/post/requestBody/content/application~1json/examples/Complete 3 parts"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AssetUploadCompletionWithPermittedActions","exampleIds":["paths/~1asset-upload-completions/post/responses/200/content/application~1json/examples/Success"]}},"schemaId":"components/schemas/AssetUploadCompletionWithPermittedActions","exampleIds":["paths/~1asset-upload-completions/post/responses/200/content/application~1json/examples/Success"]},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1asset-upload-completions/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AssetUploadCompletionWithPermittedActions","exampleIds":["paths/~1asset-upload-completions/post/responses/200/content/application~1json/examples/Success"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AssetUploadCompletionWithPermittedActions","exampleIds":["paths/~1asset-upload-completions/post/responses/200/content/application~1json/examples/Success"]}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/assets/postassetuploadcompletion"}],"panels":[]}]},"httpPath":"/asset-upload-completions"},{"label":"Get an asset's files","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/assets/getassetfiles","routeSlug":"/dash/openapi/assets/getassetfiles","metadata":{"seo":{"title":"Get an asset's files","description":"Get all of the AssetFile resources for the specified Asset."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAssetFiles","name":"Get an asset's files","isWebhook":false,"pointer":"/paths/~1assets~1{id}~1files/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get an asset's 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":"Get all of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/getassetfiles"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetFile"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources for the specified "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/getassetfiles"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetFile"},"children":[]}]}]}]}],"required":true}],"pointer":"/paths/~1assets~1{id}~1files/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/assets/{id}/files","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","4XX"],"pointer":"/assets/{id}/files","href":"assets/getassetfiles","openApiOperationId":"getAssetFiles","summary":"Get an asset's files"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_27"}},"schemaId":"schema_27"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1assets~1{id}~1files/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_27","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_27"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/assets/getassetfiles"}],"panels":[]}]},"httpPath":"/assets/{id}/files"},{"label":"Delete an asset file","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/assets/deleteassetfile","routeSlug":"/dash/openapi/assets/deleteassetfile","metadata":{"seo":{"title":"Delete an asset file","description":"Delete an AssetFile resource."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteAssetFile","name":"Delete an asset file","isWebhook":false,"pointer":"/paths/~1asset-files~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an asset 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":"Delete an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/getassetfiles"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetFile"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Asset's current AssetFile cannot be deleted and will return an error if tried."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(Only older version AssetFiles can be deleted.)"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/getassetfiles"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetFile"},"children":[]}]}]}]}],"required":true}],"pointer":"/paths/~1asset-files~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/asset-files/{id}","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","4XX"],"pointer":"/asset-files/{id}","href":"assets/deleteassetfile","openApiOperationId":"deleteAssetFile","summary":"Delete an asset file"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1asset-files~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/assets/deleteassetfile"}],"panels":[]}]},"httpPath":"/asset-files/{id}"},{"label":"Download assets","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/assets/postassetdownloadbatchjob","routeSlug":"/dash/openapi/assets/postassetdownloadbatchjob","metadata":{"seo":{"title":"Download assets","description":"An AssetDownloadBatchJob should be created when you want to download and optionally transform multiple AssetFile resources."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postAssetDownloadBatchJob","name":"Download assets","isWebhook":false,"pointer":"/paths/~1asset-download-batch-jobs/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download assets","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":"An "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/postassetdownloadbatchjob"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetDownloadBatchJob"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" should be created when you want to download and optionally transform multiple "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/getassetfiles"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetFile"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can optionally request that a zip is created of all the transformed files."},"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":"transformationDescription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request can be one of two types, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CUSTOM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PRESET"},"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":"A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CUSTOM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transformationDescription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a list of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"candidateTransformations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" which are evaluated in turn against each "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/getassetfiles"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetFile"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" specified in the request."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/getassetfiles"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetFile"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"  meets the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"candidateTransformation.criteria"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" then the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"candidateTransformation.transformation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is applied. Otherwise, the next candiate is considered."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"candidateTransformation.transformation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a series of operations to apply to the  "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/getassetfiles"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetFile"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order (e.g. resize to 200 by 100  and then covert to JPG). An empty list of operations indicates the file should be left untransformed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Putting this all together this allows you to describe a transformations 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":"Resized any image file, otherwise leave the file untransformed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Convert any image that supports transparency to PNG otherwise convert to JPG"},"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":"PRESET"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transformationDescription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is similar to a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CUSTOM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" transformation except the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transformationDescription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has been predefined."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These presets are currently only configurable via the Dash frontend, but can be found via a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/preset-transformations/postpresettransformationsearch"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PresetTransformationSearch"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AssetDownloadBatchRequest","exampleIds":["paths/~1asset-download-batch-jobs/post/requestBody/content/application~1json/examples/Resize and convert all","paths/~1asset-download-batch-jobs/post/requestBody/content/application~1json/examples/All untransformed","paths/~1asset-download-batch-jobs/post/requestBody/content/application~1json/examples/Images as JPGs otherwise untransformed"]}},"schemaId":"components/schemas/AssetDownloadBatchRequest","exampleIds":["paths/~1asset-download-batch-jobs/post/requestBody/content/application~1json/examples/Resize and convert all","paths/~1asset-download-batch-jobs/post/requestBody/content/application~1json/examples/All untransformed","paths/~1asset-download-batch-jobs/post/requestBody/content/application~1json/examples/Images as JPGs otherwise untransformed"],"pointer":"/paths/~1asset-download-batch-jobs/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/asset-download-batch-jobs","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AssetDownloadBatchRequest","exampleIds":["paths/~1asset-download-batch-jobs/post/requestBody/content/application~1json/examples/Resize and convert all","paths/~1asset-download-batch-jobs/post/requestBody/content/application~1json/examples/All untransformed","paths/~1asset-download-batch-jobs/post/requestBody/content/application~1json/examples/Images as JPGs otherwise untransformed"]}},"responseCodes":["200","4XX"],"pointer":"/asset-download-batch-jobs","href":"assets/postassetdownloadbatchjob","openApiOperationId":"postAssetDownloadBatchJob","summary":"Download assets"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/AssetDownloadBatchRequest","exampleIds":["paths/~1asset-download-batch-jobs/post/requestBody/content/application~1json/examples/Resize and convert all","paths/~1asset-download-batch-jobs/post/requestBody/content/application~1json/examples/All untransformed","paths/~1asset-download-batch-jobs/post/requestBody/content/application~1json/examples/Images as JPGs otherwise untransformed"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AssetDownloadBatchRequest","exampleIds":["paths/~1asset-download-batch-jobs/post/requestBody/content/application~1json/examples/Resize and convert all","paths/~1asset-download-batch-jobs/post/requestBody/content/application~1json/examples/All untransformed","paths/~1asset-download-batch-jobs/post/requestBody/content/application~1json/examples/Images as JPGs otherwise untransformed"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AssetDownloadBatchJob","exampleIds":["paths/~1asset-download-batch-jobs/post/responses/200/content/application~1json/examples/In progress"]}},"schemaId":"components/schemas/AssetDownloadBatchJob","exampleIds":["paths/~1asset-download-batch-jobs/post/responses/200/content/application~1json/examples/In progress"]},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1asset-download-batch-jobs/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AssetDownloadBatchJob","exampleIds":["paths/~1asset-download-batch-jobs/post/responses/200/content/application~1json/examples/In progress"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AssetDownloadBatchJob","exampleIds":["paths/~1asset-download-batch-jobs/post/responses/200/content/application~1json/examples/In progress"]}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/assets/postassetdownloadbatchjob"}],"panels":[]}]},"httpPath":"/asset-download-batch-jobs"},{"label":"Get the status of downloading assets","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/assets/getassetdownloadbatchjob","routeSlug":"/dash/openapi/assets/getassetdownloadbatchjob","metadata":{"seo":{"title":"Get the status of downloading assets","description":"Get the status and eventual result of an AssetDownloadBatchJob"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAssetDownloadBatchJob","name":"Get the status of downloading assets","isWebhook":false,"pointer":"/paths/~1asset-download-batch-jobs~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get the status of downloading assets","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":"Get the status and eventual result of an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/postassetdownloadbatchjob"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetDownloadBatchJob"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_25","required":true}],"pointer":"/paths/~1asset-download-batch-jobs~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/asset-download-batch-jobs/{id}","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","4XX"],"pointer":"/asset-download-batch-jobs/{id}","href":"assets/getassetdownloadbatchjob","openApiOperationId":"getAssetDownloadBatchJob","summary":"Get the status of downloading assets"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AssetDownloadBatchJob","exampleIds":["paths/~1asset-download-batch-jobs~1{id}/get/responses/200/content/application~1json/examples/Completed"]}},"schemaId":"components/schemas/AssetDownloadBatchJob","exampleIds":["paths/~1asset-download-batch-jobs~1{id}/get/responses/200/content/application~1json/examples/Completed"]},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1asset-download-batch-jobs~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AssetDownloadBatchJob","exampleIds":["paths/~1asset-download-batch-jobs~1{id}/get/responses/200/content/application~1json/examples/Completed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AssetDownloadBatchJob","exampleIds":["paths/~1asset-download-batch-jobs~1{id}/get/responses/200/content/application~1json/examples/Completed"]}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/assets/getassetdownloadbatchjob"}],"panels":[]}]},"httpPath":"/asset-download-batch-jobs/{id}"},{"label":"Search for assets","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/assets/postassetsearch","routeSlug":"/dash/openapi/assets/postassetsearch","metadata":{"seo":{"title":"Search for assets","description":"A standard AssetSearch will only allow you to page to 10,000 results regardless of the value returned in the totalResults property."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postAssetSearch","name":"Search for assets","isWebhook":false,"pointer":"/paths/~1asset-searches/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search for assets","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":"A standard "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/postassetsearch"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetSearch"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will only allow you to page to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"10,000"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" results regardless of the value returned in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"totalResults"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you need to be able to process more than "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"10,000"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" results consider an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/postassetscrollsearch"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AssetScrollSearch"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AssetPaginatedSearchRequest","exampleIds":["paths/~1asset-searches/post/requestBody/content/application~1json/examples/Search by field option id","paths/~1asset-searches/post/requestBody/content/application~1json/examples/Search by field value","paths/~1asset-searches/post/requestBody/content/application~1json/examples/Search by any field value","paths/~1asset-searches/post/requestBody/content/application~1json/examples/Search for field is empty","paths/~1asset-searches/post/requestBody/content/application~1json/examples/Search by date added range","paths/~1asset-searches/post/requestBody/content/application~1json/examples/Search by keywords","paths/~1asset-searches/post/requestBody/content/application~1json/examples/Search by file extension","paths/~1asset-searches/post/requestBody/content/application~1json/examples/Search by not file extension","paths/~1asset-searches/post/requestBody/content/application~1json/examples/Search by multiple file extensions","paths/~1asset-searches/post/requestBody/content/application~1json/examples/Search by filename","paths/~1asset-searches/post/requestBody/content/application~1json/examples/Search for staged assets staged by user","paths/~1asset-searches/post/requestBody/content/application~1json/examples/All assets ordered by date added","paths/~1asset-searches/post/requestBody/content/application~1json/examples/All assets in a collection","paths/~1asset-searches/post/requestBody/content/application~1json/examples/Search within assets in a collection","paths/~1asset-searches/post/requestBody/content/application~1json/examples/Match all and aggregate on filetype"]}},"schemaId":"components/schemas/AssetPaginatedSearchRequest","exampleIds":["paths/~1asset-searches/post/requestBody/content/application~1json/examples/Search by field option id","paths/~1asset-searches/post/requestBody/content/application~1json/examples/Search by field value","paths/~1asset-searches/post/requestBody/content/application~1json/examples/Search by any field value","paths/~1asset-searches/post/requestBody/content/application~1json/examples/Search for field is empty","paths/~1asset-searches/post/requestBody/content/application~1json/examples/Search by date added range","paths/~1asset-searches/post/requestBody/content/application~1json/examples/Search by keywords","paths/~1asset-searches/post/requestBody/content/application~1json/examples/Search by file extension","paths/~1asset-searches/post/requestBody/content/application~1json/examples/Search by not file extension","paths/~1asset-searches/post/requestBody/content/application~1json/examples/Search by multiple file extensions","paths/~1asset-searches/post/requestBody/content/application~1json/examples/Search by filename","paths/~1asset-searches/post/requestBody/content/application~1json/examples/Search for staged assets staged by user","paths/~1asset-searches/post/requestBody/content/application~1json/examples/All assets ordered by date added","paths/~1asset-searches/post/requestBody/content/application~1json/examples/All assets in a collection","paths/~1asset-searches/post/requestBody/content/application~1json/examples/Search within assets in a collection","paths/~1asset-searches/post/requestBody/content/application~1json/examples/Match all and aggregate on filetype"],"pointer":"/paths/~1asset-searches/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/asset-searches","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AssetPaginatedSearchRequest","exampleIds":["paths/~1asset-searches/post/requestBody/content/application~1json/examples/Search by field option id","paths/~1asset-searches/post/requestBody/content/application~1json/examples/Search by field value","paths/~1asset-searches/post/requestBody/content/application~1json/examples/Search by any field value","paths/~1asset-searches/post/requestBody/content/application~1json/examples/Search for field is empty","paths/~1asset-searches/post/requestBody/content/application~1json/examples/Search by date added range","paths/~1asset-searches/post/requestBody/content/application~1json/examples/Search by keywords","paths/~1asset-searches/post/requestBody/content/application~1json/examples/Search by file extension","paths/~1asset-searches/post/requestBody/content/application~1json/examples/Search by not file extension","paths/~1asset-searches/post/requestBody/content/application~1json/examples/Search by multiple file extensions","paths/~1asset-searches/post/requestBody/content/application~1json/examples/Search by filename","paths/~1asset-searches/post/requestBody/content/application~1json/examples/Search for staged assets staged by user","paths/~1asset-searches/post/requestBody/content/application~1json/examples/All assets ordered by date added","paths/~1asset-searches/post/requestBody/content/application~1json/examples/All assets in a collection","paths/~1asset-searches/post/requestBody/content/application~1json/examples/Search within assets in a collection","paths/~1asset-searches/post/requestBody/content/application~1json/examples/Match all and aggregate on filetype"]}},"responseCodes":["200","4XX"],"pointer":"/asset-searches","href":"assets/postassetsearch","openApiOperationId":"postAssetSearch","summary":"Search for assets"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/AssetPaginatedSearchRequest","exampleIds":["paths/~1asset-searches/post/requestBody/content/application~1json/examples/Search by field option id","paths/~1asset-searches/post/requestBody/content/application~1json/examples/Search by field value","paths/~1asset-searches/post/requestBody/content/application~1json/examples/Search by any field value","paths/~1asset-searches/post/requestBody/content/application~1json/examples/Search for field is empty","paths/~1asset-searches/post/requestBody/content/application~1json/examples/Search by date added range","paths/~1asset-searches/post/requestBody/content/application~1json/examples/Search by keywords","paths/~1asset-searches/post/requestBody/content/application~1json/examples/Search by file extension","paths/~1asset-searches/post/requestBody/content/application~1json/examples/Search by not file extension","paths/~1asset-searches/post/requestBody/content/application~1json/examples/Search by multiple file extensions","paths/~1asset-searches/post/requestBody/content/application~1json/examples/Search by filename","paths/~1asset-searches/post/requestBody/content/application~1json/examples/Search for staged assets staged by user","paths/~1asset-searches/post/requestBody/content/application~1json/examples/All assets ordered by date added","paths/~1asset-searches/post/requestBody/content/application~1json/examples/All assets in a collection","paths/~1asset-searches/post/requestBody/content/application~1json/examples/Search within assets in a collection","paths/~1asset-searches/post/requestBody/content/application~1json/examples/Match all and aggregate on filetype"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AssetPaginatedSearchRequest","exampleIds":["paths/~1asset-searches/post/requestBody/content/application~1json/examples/Search by field option id","paths/~1asset-searches/post/requestBody/content/application~1json/examples/Search by field value","paths/~1asset-searches/post/requestBody/content/application~1json/examples/Search by any field value","paths/~1asset-searches/post/requestBody/content/application~1json/examples/Search for field is empty","paths/~1asset-searches/post/requestBody/content/application~1json/examples/Search by date added range","paths/~1asset-searches/post/requestBody/content/application~1json/examples/Search by keywords","paths/~1asset-searches/post/requestBody/content/application~1json/examples/Search by file extension","paths/~1asset-searches/post/requestBody/content/application~1json/examples/Search by not file extension","paths/~1asset-searches/post/requestBody/content/application~1json/examples/Search by multiple file extensions","paths/~1asset-searches/post/requestBody/content/application~1json/examples/Search by filename","paths/~1asset-searches/post/requestBody/content/application~1json/examples/Search for staged assets staged by user","paths/~1asset-searches/post/requestBody/content/application~1json/examples/All assets ordered by date added","paths/~1asset-searches/post/requestBody/content/application~1json/examples/All assets in a collection","paths/~1asset-searches/post/requestBody/content/application~1json/examples/Search within assets in a collection","paths/~1asset-searches/post/requestBody/content/application~1json/examples/Match all and aggregate on filetype"]}},"examples":[{},{},{},{},{},{},{},{},{},{},{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AssetSearch"}},"schemaId":"components/schemas/AssetSearch"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1asset-searches/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AssetSearch","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AssetSearch"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/assets/postassetsearch"}],"panels":[]}]},"httpPath":"/asset-searches"},{"label":"Scroll search for assets","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/assets/postassetscrollsearch","routeSlug":"/dash/openapi/assets/postassetscrollsearch","metadata":{"seo":{"title":"Scroll search for assets","description":"Asset scroll searches provide a means of scrolling one way through search results of any number of Asset resources."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postAssetScrollSearch","name":"Scroll search for assets","isWebhook":false,"pointer":"/paths/~1asset-scroll-searches/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Scroll search for assets","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":"Asset scroll searches provide a means of scrolling one way through search results of any number of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Page size can stil be specified, but a scroll search will always proceed sequentially once through each 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":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/postassetscrollsearch"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetScrollSearch.scrollId"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the search the response is used to "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/postassetscrollsearchScroll"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"continue the scroll search"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AssetScrollSearchRequest","exampleIds":["paths/~1asset-scroll-searches/post/requestBody/content/application~1json/examples/All assets ordered by date added"]}},"schemaId":"components/schemas/AssetScrollSearchRequest","exampleIds":["paths/~1asset-scroll-searches/post/requestBody/content/application~1json/examples/All assets ordered by date added"],"pointer":"/paths/~1asset-scroll-searches/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/asset-scroll-searches","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AssetScrollSearchRequest","exampleIds":["paths/~1asset-scroll-searches/post/requestBody/content/application~1json/examples/All assets ordered by date added"]}},"responseCodes":["200","4XX"],"pointer":"/asset-scroll-searches","href":"assets/postassetscrollsearch","openApiOperationId":"postAssetScrollSearch","summary":"Scroll search for assets"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/AssetScrollSearchRequest","exampleIds":["paths/~1asset-scroll-searches/post/requestBody/content/application~1json/examples/All assets ordered by date added"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AssetScrollSearchRequest","exampleIds":["paths/~1asset-scroll-searches/post/requestBody/content/application~1json/examples/All assets ordered by date added"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AssetScrollSearch"}},"schemaId":"components/schemas/AssetScrollSearch"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1asset-scroll-searches/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AssetScrollSearch","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AssetScrollSearch"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/assets/postassetscrollsearch"}],"panels":[]}]},"httpPath":"/asset-scroll-searches"},{"label":"Continue an asset scroll search","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/assets/postassetscrollsearchscroll","routeSlug":"/dash/openapi/assets/postassetscrollsearchscroll","metadata":{"seo":{"title":"Continue an asset scroll search","description":"Continue a previoulsy started AssetScrollSearch."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postAssetScrollSearchScroll","name":"Continue an asset scroll search","isWebhook":false,"pointer":"/paths/~1asset-scroll-search-scrolls/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Continue an asset scroll search","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":"Continue a previoulsy started "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/postassetscrollsearch"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetScrollSearch"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"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":"You must use the scrollId resturned in each new response as a scrollId is not guarenteed to remain fixed over the course of a scroll"},"children":[]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AssetScrollSearchScrollRequest"}},"schemaId":"components/schemas/AssetScrollSearchScrollRequest","pointer":"/paths/~1asset-scroll-search-scrolls/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/asset-scroll-search-scrolls","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AssetScrollSearchScrollRequest"}},"responseCodes":["200","4XX"],"pointer":"/asset-scroll-search-scrolls","href":"assets/postassetscrollsearchscroll","openApiOperationId":"postAssetScrollSearchScroll","summary":"Continue an asset scroll search"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/AssetScrollSearchScrollRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AssetScrollSearchScrollRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AssetScrollSearch"}},"schemaId":"components/schemas/AssetScrollSearch"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1asset-scroll-search-scrolls/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AssetScrollSearch","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AssetScrollSearch"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/assets/postassetscrollsearchscroll"}],"panels":[]}]},"httpPath":"/asset-scroll-search-scrolls"},{"label":"Update assets' metadata","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/assets/postassetmetadataeditbatchjob","routeSlug":"/dash/openapi/assets/postassetmetadataeditbatchjob","metadata":{"seo":{"title":"Update assets' metadata","description":"Edit the metadata of a set of Assets by the specified assets selector."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postAssetMetadataEditBatchJob","name":"Update assets' metadata","isWebhook":false,"pointer":"/paths/~1asset-metadata-edit-batch-jobs/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update assets' metadata","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":"Edit the metadata of a set of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"s by the specified assets selector."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BY_IDS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" selector to edit a specific list of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset.ids"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BY_CRITERION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" selector to edit a search criterion, e.g. all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"s in a specific folder.  See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/postassetsearch"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetSearch"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more detail on the available criterion."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"metadataFieldValueUpdates"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" also has two types of objects that can be used.  For example, a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of \"My Option\" and an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of \"3ba2cb5b-dbe9-48ed-8e07-71f26929e617\" can be set either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BY_VALUES"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" \"My Option\", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BY_IDS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" \"3ba2cb5b-dbe9-48ed-8e07-71f26929e617\".  For "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that do not have "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOptions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (e.g. text fields), either type can be used."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MetadataEditBatchRequest","exampleIds":["paths/~1asset-metadata-edit-batch-jobs/post/requestBody/content/application~1json/examples/Metadata only","paths/~1asset-metadata-edit-batch-jobs/post/requestBody/content/application~1json/examples/Variant criterion SET only","paths/~1asset-metadata-edit-batch-jobs/post/requestBody/content/application~1json/examples/Metadata and variant criterion SET","paths/~1asset-metadata-edit-batch-jobs/post/requestBody/content/application~1json/examples/Variant criterion REMOVE"]}},"schemaId":"components/schemas/MetadataEditBatchRequest","exampleIds":["paths/~1asset-metadata-edit-batch-jobs/post/requestBody/content/application~1json/examples/Metadata only","paths/~1asset-metadata-edit-batch-jobs/post/requestBody/content/application~1json/examples/Variant criterion SET only","paths/~1asset-metadata-edit-batch-jobs/post/requestBody/content/application~1json/examples/Metadata and variant criterion SET","paths/~1asset-metadata-edit-batch-jobs/post/requestBody/content/application~1json/examples/Variant criterion REMOVE"],"pointer":"/paths/~1asset-metadata-edit-batch-jobs/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/asset-metadata-edit-batch-jobs","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/MetadataEditBatchRequest","exampleIds":["paths/~1asset-metadata-edit-batch-jobs/post/requestBody/content/application~1json/examples/Metadata only","paths/~1asset-metadata-edit-batch-jobs/post/requestBody/content/application~1json/examples/Variant criterion SET only","paths/~1asset-metadata-edit-batch-jobs/post/requestBody/content/application~1json/examples/Metadata and variant criterion SET","paths/~1asset-metadata-edit-batch-jobs/post/requestBody/content/application~1json/examples/Variant criterion REMOVE"]}},"responseCodes":["200","4XX"],"pointer":"/asset-metadata-edit-batch-jobs","href":"assets/postassetmetadataeditbatchjob","openApiOperationId":"postAssetMetadataEditBatchJob","summary":"Update assets' metadata"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/MetadataEditBatchRequest","exampleIds":["paths/~1asset-metadata-edit-batch-jobs/post/requestBody/content/application~1json/examples/Metadata only","paths/~1asset-metadata-edit-batch-jobs/post/requestBody/content/application~1json/examples/Variant criterion SET only","paths/~1asset-metadata-edit-batch-jobs/post/requestBody/content/application~1json/examples/Metadata and variant criterion SET","paths/~1asset-metadata-edit-batch-jobs/post/requestBody/content/application~1json/examples/Variant criterion REMOVE"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MetadataEditBatchRequest","exampleIds":["paths/~1asset-metadata-edit-batch-jobs/post/requestBody/content/application~1json/examples/Metadata only","paths/~1asset-metadata-edit-batch-jobs/post/requestBody/content/application~1json/examples/Variant criterion SET only","paths/~1asset-metadata-edit-batch-jobs/post/requestBody/content/application~1json/examples/Metadata and variant criterion SET","paths/~1asset-metadata-edit-batch-jobs/post/requestBody/content/application~1json/examples/Variant criterion REMOVE"]}},"examples":[{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NoResultJob","exampleIds":["paths/~1asset-metadata-edit-batch-jobs/post/responses/200/content/application~1json/examples/In progress","paths/~1asset-metadata-edit-batch-jobs/post/responses/200/content/application~1json/examples/Complete"]}},"schemaId":"components/schemas/NoResultJob","exampleIds":["paths/~1asset-metadata-edit-batch-jobs/post/responses/200/content/application~1json/examples/In progress","paths/~1asset-metadata-edit-batch-jobs/post/responses/200/content/application~1json/examples/Complete"]},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1asset-metadata-edit-batch-jobs/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/NoResultJob","exampleIds":["paths/~1asset-metadata-edit-batch-jobs/post/responses/200/content/application~1json/examples/In progress","paths/~1asset-metadata-edit-batch-jobs/post/responses/200/content/application~1json/examples/Complete"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NoResultJob","exampleIds":["paths/~1asset-metadata-edit-batch-jobs/post/responses/200/content/application~1json/examples/In progress","paths/~1asset-metadata-edit-batch-jobs/post/responses/200/content/application~1json/examples/Complete"]}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/assets/postassetmetadataeditbatchjob"}],"panels":[]}]},"httpPath":"/asset-metadata-edit-batch-jobs"},{"label":"Get the status of updating assets' metadata","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/assets/getassetmetadataeditbatchjob","routeSlug":"/dash/openapi/assets/getassetmetadataeditbatchjob","metadata":{"seo":{"title":"Get the status of updating assets' metadata","description":"Get the status of a Asset Metadata Edit Batch Job"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAssetMetadataEditBatchJob","name":"Get the status of updating assets' metadata","isWebhook":false,"pointer":"/paths/~1asset-metadata-edit-batch-jobs~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get the status of updating assets' metadata","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":"Get the status of a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/postassetmetadataeditbatchjob"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset Metadata Edit Batch Job"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_25","required":true}],"pointer":"/paths/~1asset-metadata-edit-batch-jobs~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/asset-metadata-edit-batch-jobs/{id}","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","4XX"],"pointer":"/asset-metadata-edit-batch-jobs/{id}","href":"assets/getassetmetadataeditbatchjob","openApiOperationId":"getAssetMetadataEditBatchJob","summary":"Get the status of updating assets' metadata"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NoResultJob","exampleIds":["paths/~1asset-metadata-edit-batch-jobs~1{id}/get/responses/200/content/application~1json/examples/In progress","paths/~1asset-metadata-edit-batch-jobs~1{id}/get/responses/200/content/application~1json/examples/Complete"]}},"schemaId":"components/schemas/NoResultJob","exampleIds":["paths/~1asset-metadata-edit-batch-jobs~1{id}/get/responses/200/content/application~1json/examples/In progress","paths/~1asset-metadata-edit-batch-jobs~1{id}/get/responses/200/content/application~1json/examples/Complete"]},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1asset-metadata-edit-batch-jobs~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/NoResultJob","exampleIds":["paths/~1asset-metadata-edit-batch-jobs~1{id}/get/responses/200/content/application~1json/examples/In progress","paths/~1asset-metadata-edit-batch-jobs~1{id}/get/responses/200/content/application~1json/examples/Complete"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NoResultJob","exampleIds":["paths/~1asset-metadata-edit-batch-jobs~1{id}/get/responses/200/content/application~1json/examples/In progress","paths/~1asset-metadata-edit-batch-jobs~1{id}/get/responses/200/content/application~1json/examples/Complete"]}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/assets/getassetmetadataeditbatchjob"}],"panels":[]}]},"httpPath":"/asset-metadata-edit-batch-jobs/{id}"},{"label":"Get metadata suggestions for assets","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/assets/postassetmetadatasuggestionbatchjob","routeSlug":"/dash/openapi/assets/postassetmetadatasuggestionbatchjob","metadata":{"seo":{"title":"Get metadata suggestions for assets","description":"Get metadata suggestions for a set of Assets by the specified assets selector."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postAssetMetadataSuggestionBatchJob","name":"Get metadata suggestions for assets","isWebhook":false,"pointer":"/paths/~1asset-metadata-suggestion-batch-jobs/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get metadata suggestions for assets","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":"Get metadata suggestions for a set of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"s by the specified assets selector."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BY_IDS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" selector to get suggestions for a specific list of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset.ids"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BY_CRITERION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" selector to get suggestions for a search criterion, e.g. all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"s in a specific folder.  See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/postassetsearch"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetSearch"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more detail on the available criterion."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MetadataSuggestionBatchRequest"}},"schemaId":"components/schemas/MetadataSuggestionBatchRequest","pointer":"/paths/~1asset-metadata-suggestion-batch-jobs/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/asset-metadata-suggestion-batch-jobs","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/MetadataSuggestionBatchRequest"}},"responseCodes":["200","4XX"],"pointer":"/asset-metadata-suggestion-batch-jobs","href":"assets/postassetmetadatasuggestionbatchjob","openApiOperationId":"postAssetMetadataSuggestionBatchJob","summary":"Get metadata suggestions for assets"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/MetadataSuggestionBatchRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MetadataSuggestionBatchRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MetadataSuggestionBatchJob","exampleIds":["paths/~1asset-metadata-suggestion-batch-jobs/post/responses/200/content/application~1json/examples/In progress","paths/~1asset-metadata-suggestion-batch-jobs/post/responses/200/content/application~1json/examples/Complete"]}},"schemaId":"components/schemas/MetadataSuggestionBatchJob","exampleIds":["paths/~1asset-metadata-suggestion-batch-jobs/post/responses/200/content/application~1json/examples/In progress","paths/~1asset-metadata-suggestion-batch-jobs/post/responses/200/content/application~1json/examples/Complete"]},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1asset-metadata-suggestion-batch-jobs/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/MetadataSuggestionBatchJob","exampleIds":["paths/~1asset-metadata-suggestion-batch-jobs/post/responses/200/content/application~1json/examples/In progress","paths/~1asset-metadata-suggestion-batch-jobs/post/responses/200/content/application~1json/examples/Complete"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MetadataSuggestionBatchJob","exampleIds":["paths/~1asset-metadata-suggestion-batch-jobs/post/responses/200/content/application~1json/examples/In progress","paths/~1asset-metadata-suggestion-batch-jobs/post/responses/200/content/application~1json/examples/Complete"]}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/assets/postassetmetadatasuggestionbatchjob"}],"panels":[]}]},"httpPath":"/asset-metadata-suggestion-batch-jobs"},{"label":"Create rejected asset metadata suggestions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/assets/postrejectedassetmetadatasuggestionbatches","routeSlug":"/dash/openapi/assets/postrejectedassetmetadatasuggestionbatches","metadata":{"seo":{"title":"Create rejected asset metadata suggestions","description":"Record the fact that some asset metadata suggestions have been rejected, and should therefore not be suggested again for the given asset."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postRejectedAssetMetadataSuggestionBatches","name":"Create rejected asset metadata suggestions","isWebhook":false,"pointer":"/paths/~1rejected-asset-metadata-suggestion-batches/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create rejected asset metadata suggestions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Record the fact that some asset metadata suggestions have been rejected, and should therefore not be suggested again for the given asset.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RejectedMetadataSuggestionBatchRequest"}},"schemaId":"components/schemas/RejectedMetadataSuggestionBatchRequest","pointer":"/paths/~1rejected-asset-metadata-suggestion-batches/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/rejected-asset-metadata-suggestion-batches","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RejectedMetadataSuggestionBatchRequest"}},"responseCodes":["200","4XX"],"pointer":"/rejected-asset-metadata-suggestion-batches","href":"assets/postrejectedassetmetadatasuggestionbatches","openApiOperationId":"postRejectedAssetMetadataSuggestionBatches","summary":"Create rejected asset metadata suggestions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/RejectedMetadataSuggestionBatchRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RejectedMetadataSuggestionBatchRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RejectedMetadataSuggestionBatch"}},"schemaId":"components/schemas/RejectedMetadataSuggestionBatch"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1rejected-asset-metadata-suggestion-batches/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/RejectedMetadataSuggestionBatch","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RejectedMetadataSuggestionBatch"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/assets/postrejectedassetmetadatasuggestionbatches"}],"panels":[]}]},"httpPath":"/rejected-asset-metadata-suggestion-batches"},{"label":"Get the status of metadata suggestions for assets","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/assets/getassetmetadatasuggestionbatchjob","routeSlug":"/dash/openapi/assets/getassetmetadatasuggestionbatchjob","metadata":{"seo":{"title":"Get the status of metadata suggestions for assets","description":"Get the status of a Asset Suggestion Edit Batch Job"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAssetMetadataSuggestionBatchJob","name":"Get the status of metadata suggestions for assets","isWebhook":false,"pointer":"/paths/~1asset-metadata-suggestion-batch-jobs~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get the status of metadata suggestions for assets","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":"Get the status of a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/postassetmetadatasuggestionbatchjob"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset Suggestion Edit Batch Job"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_25","required":true}],"pointer":"/paths/~1asset-metadata-suggestion-batch-jobs~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/asset-metadata-suggestion-batch-jobs/{id}","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","4XX"],"pointer":"/asset-metadata-suggestion-batch-jobs/{id}","href":"assets/getassetmetadatasuggestionbatchjob","openApiOperationId":"getAssetMetadataSuggestionBatchJob","summary":"Get the status of metadata suggestions for assets"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MetadataSuggestionBatchJob","exampleIds":["paths/~1asset-metadata-suggestion-batch-jobs~1{id}/get/responses/200/content/application~1json/examples/In progress","paths/~1asset-metadata-suggestion-batch-jobs~1{id}/get/responses/200/content/application~1json/examples/Complete"]}},"schemaId":"components/schemas/MetadataSuggestionBatchJob","exampleIds":["paths/~1asset-metadata-suggestion-batch-jobs~1{id}/get/responses/200/content/application~1json/examples/In progress","paths/~1asset-metadata-suggestion-batch-jobs~1{id}/get/responses/200/content/application~1json/examples/Complete"]},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1asset-metadata-suggestion-batch-jobs~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/MetadataSuggestionBatchJob","exampleIds":["paths/~1asset-metadata-suggestion-batch-jobs~1{id}/get/responses/200/content/application~1json/examples/In progress","paths/~1asset-metadata-suggestion-batch-jobs~1{id}/get/responses/200/content/application~1json/examples/Complete"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MetadataSuggestionBatchJob","exampleIds":["paths/~1asset-metadata-suggestion-batch-jobs~1{id}/get/responses/200/content/application~1json/examples/In progress","paths/~1asset-metadata-suggestion-batch-jobs~1{id}/get/responses/200/content/application~1json/examples/Complete"]}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/assets/getassetmetadatasuggestionbatchjob"}],"panels":[]}]},"httpPath":"/asset-metadata-suggestion-batch-jobs/{id}"},{"label":"Update assets' lifecycle stage","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/assets/postassetlifecycletransitionbatchjob","routeSlug":"/dash/openapi/assets/postassetlifecycletransitionbatchjob","metadata":{"seo":{"title":"Update assets' lifecycle stage","description":"Move a set of Asset resources from one Asset.lifecycleStatus.state to another."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postAssetLifecycleTransitionBatchJob","name":"Update assets' lifecycle stage","isWebhook":false,"pointer":"/paths/~1asset-lifecycle-transition-batch-jobs/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update assets' lifecycle stage","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":"Move a set of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources from one "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset.lifecycleStatus.state"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to another."},"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":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources to be added to the batch job are specified using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/postassetsearch"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetSearch"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" criteria language or by a simple set of ids"},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"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":"If you are selecting by search criteria you must explicitly include criteria describing the state you are moving from in order to account for the fact that the Dash API will only return Assets in the 'LIVE' state by default. See the request examples for more."},"children":[]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LifecycleTransitionBatchRequest","exampleIds":["paths/~1asset-lifecycle-transition-batch-jobs/post/requestBody/content/application~1json/examples/Move all staged by user to pending approval","paths/~1asset-lifecycle-transition-batch-jobs/post/requestBody/content/application~1json/examples/Move all in pending approval to live","paths/~1asset-lifecycle-transition-batch-jobs/post/requestBody/content/application~1json/examples/Move specific asset to pending approval","paths/~1asset-lifecycle-transition-batch-jobs/post/requestBody/content/application~1json/examples/Move specific assets to pending approval"]}},"schemaId":"components/schemas/LifecycleTransitionBatchRequest","exampleIds":["paths/~1asset-lifecycle-transition-batch-jobs/post/requestBody/content/application~1json/examples/Move all staged by user to pending approval","paths/~1asset-lifecycle-transition-batch-jobs/post/requestBody/content/application~1json/examples/Move all in pending approval to live","paths/~1asset-lifecycle-transition-batch-jobs/post/requestBody/content/application~1json/examples/Move specific asset to pending approval","paths/~1asset-lifecycle-transition-batch-jobs/post/requestBody/content/application~1json/examples/Move specific assets to pending approval"],"pointer":"/paths/~1asset-lifecycle-transition-batch-jobs/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/asset-lifecycle-transition-batch-jobs","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/LifecycleTransitionBatchRequest","exampleIds":["paths/~1asset-lifecycle-transition-batch-jobs/post/requestBody/content/application~1json/examples/Move all staged by user to pending approval","paths/~1asset-lifecycle-transition-batch-jobs/post/requestBody/content/application~1json/examples/Move all in pending approval to live","paths/~1asset-lifecycle-transition-batch-jobs/post/requestBody/content/application~1json/examples/Move specific asset to pending approval","paths/~1asset-lifecycle-transition-batch-jobs/post/requestBody/content/application~1json/examples/Move specific assets to pending approval"]}},"responseCodes":["200","4XX"],"pointer":"/asset-lifecycle-transition-batch-jobs","href":"assets/postassetlifecycletransitionbatchjob","openApiOperationId":"postAssetLifecycleTransitionBatchJob","summary":"Update assets' lifecycle stage"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/LifecycleTransitionBatchRequest","exampleIds":["paths/~1asset-lifecycle-transition-batch-jobs/post/requestBody/content/application~1json/examples/Move all staged by user to pending approval","paths/~1asset-lifecycle-transition-batch-jobs/post/requestBody/content/application~1json/examples/Move all in pending approval to live","paths/~1asset-lifecycle-transition-batch-jobs/post/requestBody/content/application~1json/examples/Move specific asset to pending approval","paths/~1asset-lifecycle-transition-batch-jobs/post/requestBody/content/application~1json/examples/Move specific assets to pending approval"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LifecycleTransitionBatchRequest","exampleIds":["paths/~1asset-lifecycle-transition-batch-jobs/post/requestBody/content/application~1json/examples/Move all staged by user to pending approval","paths/~1asset-lifecycle-transition-batch-jobs/post/requestBody/content/application~1json/examples/Move all in pending approval to live","paths/~1asset-lifecycle-transition-batch-jobs/post/requestBody/content/application~1json/examples/Move specific asset to pending approval","paths/~1asset-lifecycle-transition-batch-jobs/post/requestBody/content/application~1json/examples/Move specific assets to pending approval"]}},"examples":[{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NoResultJob","exampleIds":["paths/~1asset-lifecycle-transition-batch-jobs/post/responses/200/content/application~1json/examples/In progress"]}},"schemaId":"components/schemas/NoResultJob","exampleIds":["paths/~1asset-lifecycle-transition-batch-jobs/post/responses/200/content/application~1json/examples/In progress"]},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1asset-lifecycle-transition-batch-jobs/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/NoResultJob","exampleIds":["paths/~1asset-lifecycle-transition-batch-jobs/post/responses/200/content/application~1json/examples/In progress"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NoResultJob","exampleIds":["paths/~1asset-lifecycle-transition-batch-jobs/post/responses/200/content/application~1json/examples/In progress"]}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/assets/postassetlifecycletransitionbatchjob"}],"panels":[]}]},"httpPath":"/asset-lifecycle-transition-batch-jobs"},{"label":"Get the status of updating assets' lifecycle stage","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/assets/getassetlifecycletransitionbatchjob","routeSlug":"/dash/openapi/assets/getassetlifecycletransitionbatchjob","metadata":{"seo":{"title":"Get the status of updating assets' lifecycle stage","description":"Get the status of an AssetLifecycleTransitionBatchJob"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAssetLifecycleTransitionBatchJob","name":"Get the status of updating assets' lifecycle stage","isWebhook":false,"pointer":"/paths/~1asset-lifecycle-transition-batch-jobs~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get the status of updating assets' lifecycle stage","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":"Get the status of an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/postassetlifecycletransitionbatchjob"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetLifecycleTransitionBatchJob"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_25","required":true}],"pointer":"/paths/~1asset-lifecycle-transition-batch-jobs~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/asset-lifecycle-transition-batch-jobs/{id}","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","4XX"],"pointer":"/asset-lifecycle-transition-batch-jobs/{id}","href":"assets/getassetlifecycletransitionbatchjob","openApiOperationId":"getAssetLifecycleTransitionBatchJob","summary":"Get the status of updating assets' lifecycle stage"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NoResultJob","exampleIds":["paths/~1asset-lifecycle-transition-batch-jobs~1{id}/get/responses/200/content/application~1json/examples/Complete"]}},"schemaId":"components/schemas/NoResultJob","exampleIds":["paths/~1asset-lifecycle-transition-batch-jobs~1{id}/get/responses/200/content/application~1json/examples/Complete"]},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1asset-lifecycle-transition-batch-jobs~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/NoResultJob","exampleIds":["paths/~1asset-lifecycle-transition-batch-jobs~1{id}/get/responses/200/content/application~1json/examples/Complete"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NoResultJob","exampleIds":["paths/~1asset-lifecycle-transition-batch-jobs~1{id}/get/responses/200/content/application~1json/examples/Complete"]}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/assets/getassetlifecycletransitionbatchjob"}],"panels":[]}]},"httpPath":"/asset-lifecycle-transition-batch-jobs/{id}"},{"label":"Delete assets","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/assets/postassetdeletionbatchjob","routeSlug":"/dash/openapi/assets/postassetdeletionbatchjob","metadata":{"seo":{"title":"Delete assets","description":"Delete a set of Asset by the specified assets selector"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postAssetDeletionBatchJob","name":"Delete assets","isWebhook":false,"pointer":"/paths/~1asset-deletion-batch-jobs/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete assets","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":"Delete a set of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by the specified assets selector"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MetadataSuggestionBatchRequest"}},"schemaId":"components/schemas/MetadataSuggestionBatchRequest","pointer":"/paths/~1asset-deletion-batch-jobs/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/asset-deletion-batch-jobs","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/MetadataSuggestionBatchRequest"}},"responseCodes":["200","4XX"],"pointer":"/asset-deletion-batch-jobs","href":"assets/postassetdeletionbatchjob","openApiOperationId":"postAssetDeletionBatchJob","summary":"Delete assets"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/MetadataSuggestionBatchRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MetadataSuggestionBatchRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NoResultJob"}},"schemaId":"components/schemas/NoResultJob"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1asset-deletion-batch-jobs/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/NoResultJob","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NoResultJob"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/assets/postassetdeletionbatchjob"}],"panels":[]}]},"httpPath":"/asset-deletion-batch-jobs"}],"content":{"contentType":"group","meta":{"name":"Assets"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Assets","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the main resource in Dash. It consists of:"},"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":"One or more "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/getassetfiles"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetFile"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources, detailing the versions of a file for an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Only the current "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/getassetfiles"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetFile"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is returned with the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource. Use "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/getassetfiles"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET Asset Files"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to retrieve all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/getassetfiles"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetFile"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources for an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset.metadata"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" which defines the assigned values for this "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A number of fixed properties, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"addedBy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User.id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of whoever added the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For the sake of performance any "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources referenced in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset.metadata.values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will need to be retrieved separately, if required."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/assets/{id}","summary":"Get an asset.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/assets/getasset","deprecated":false},{"title":"/assets/{id}","summary":"Delete an asset","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/assets/deleteasset","deprecated":false},{"title":"/assets/{id}","summary":"Update an asset","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/assets/patchasset","deprecated":false},{"title":"/assets-creations","summary":"Create some new assets","prefix":{"name":"post","color":"post"},"badges":[],"link":"/assets/postassetscreations","deprecated":false},{"title":"/asset-and-upload-batch-jobs","summary":"Create assets and upload files","prefix":{"name":"post","color":"post"},"badges":[],"link":"/assets/postassetanduploadbatchjob","deprecated":false},{"title":"/asset-and-upload-batch-jobs/{id}","summary":"Get the status of creating assets and uploading files","prefix":{"name":"get","color":"get"},"badges":[],"link":"/assets/getassetanduploadbatchjob","deprecated":false},{"title":"/asset-uploads","summary":"Upload an asset file","prefix":{"name":"post","color":"post"},"badges":[],"link":"/assets/postassetupload","deprecated":false},{"title":"/asset-upload-batch-jobs","summary":"Upload files to assets","prefix":{"name":"post","color":"post"},"badges":[],"link":"/assets/postassetuploadbatchjob","deprecated":false},{"title":"/asset-upload-batch-jobs/{id}","summary":"Get the status of uploading files","prefix":{"name":"get","color":"get"},"badges":[],"link":"/assets/getassetuploadbatchjob","deprecated":false},{"title":"/asset-upload-completions","summary":"Complete an asset file upload","prefix":{"name":"post","color":"post"},"badges":[],"link":"/assets/postassetuploadcompletion","deprecated":false},{"title":"/assets/{id}/files","summary":"Get an asset's files","prefix":{"name":"get","color":"get"},"badges":[],"link":"/assets/getassetfiles","deprecated":false},{"title":"/asset-files/{id}","summary":"Delete an asset file","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/assets/deleteassetfile","deprecated":false},{"title":"/asset-download-batch-jobs","summary":"Download assets","prefix":{"name":"post","color":"post"},"badges":[],"link":"/assets/postassetdownloadbatchjob","deprecated":false},{"title":"/asset-download-batch-jobs/{id}","summary":"Get the status of downloading assets","prefix":{"name":"get","color":"get"},"badges":[],"link":"/assets/getassetdownloadbatchjob","deprecated":false},{"title":"/asset-searches","summary":"Search for assets","prefix":{"name":"post","color":"post"},"badges":[],"link":"/assets/postassetsearch","deprecated":false},{"title":"/asset-scroll-searches","summary":"Scroll search for assets","prefix":{"name":"post","color":"post"},"badges":[],"link":"/assets/postassetscrollsearch","deprecated":false},{"title":"/asset-scroll-search-scrolls","summary":"Continue an asset scroll search","prefix":{"name":"post","color":"post"},"badges":[],"link":"/assets/postassetscrollsearchscroll","deprecated":false},{"title":"/asset-metadata-edit-batch-jobs","summary":"Update assets' metadata","prefix":{"name":"post","color":"post"},"badges":[],"link":"/assets/postassetmetadataeditbatchjob","deprecated":false},{"title":"/asset-metadata-edit-batch-jobs/{id}","summary":"Get the status of updating assets' metadata","prefix":{"name":"get","color":"get"},"badges":[],"link":"/assets/getassetmetadataeditbatchjob","deprecated":false},{"title":"/asset-metadata-suggestion-batch-jobs","summary":"Get metadata suggestions for assets","prefix":{"name":"post","color":"post"},"badges":[],"link":"/assets/postassetmetadatasuggestionbatchjob","deprecated":false},{"title":"/rejected-asset-metadata-suggestion-batches","summary":"Create rejected asset metadata suggestions","prefix":{"name":"post","color":"post"},"badges":[],"link":"/assets/postrejectedassetmetadatasuggestionbatches","deprecated":false},{"title":"/asset-metadata-suggestion-batch-jobs/{id}","summary":"Get the status of metadata suggestions for assets","prefix":{"name":"get","color":"get"},"badges":[],"link":"/assets/getassetmetadatasuggestionbatchjob","deprecated":false},{"title":"/asset-lifecycle-transition-batch-jobs","summary":"Update assets' lifecycle stage","prefix":{"name":"post","color":"post"},"badges":[],"link":"/assets/postassetlifecycletransitionbatchjob","deprecated":false},{"title":"/asset-lifecycle-transition-batch-jobs/{id}","summary":"Get the status of updating assets' lifecycle stage","prefix":{"name":"get","color":"get"},"badges":[],"link":"/assets/getassetlifecycletransitionbatchjob","deprecated":false},{"title":"/asset-deletion-batch-jobs","summary":"Delete assets","prefix":{"name":"post","color":"post"},"badges":[],"link":"/assets/postassetdeletionbatchjob","deprecated":false}]}]}]}]}},{"type":"group","label":"Asset Comments","link":"/dash/openapi/asset-comments","routeSlug":"/dash/openapi/asset-comments","items":[{"label":"Get an asset's comments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/asset-comments/getassetcomments","routeSlug":"/dash/openapi/asset-comments/getassetcomments","metadata":{"seo":{"title":"Get an asset's comments","description":"Get all of the Comment resources for the specified Asset."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAssetComments","name":"Get an asset's comments","isWebhook":false,"pointer":"/paths/~1assets~1{id}~1comments/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get an asset's comments","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":"Get all of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Asset-Comments"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Comment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources for the specified "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]}]}]}],"required":true}],"pointer":"/paths/~1assets~1{id}~1comments/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/assets/{id}/comments","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","4XX"],"pointer":"/assets/{id}/comments","href":"asset-comments/getassetcomments","openApiOperationId":"getAssetComments","summary":"Get an asset's comments"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_28"}},"schemaId":"schema_28"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1assets~1{id}~1comments/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_28","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_28"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/asset-comments/getassetcomments"}],"panels":[]}]},"httpPath":"/assets/{id}/comments"},{"label":"Create a comment on an asset","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/asset-comments/postassetcomments","routeSlug":"/dash/openapi/asset-comments/postassetcomments","metadata":{"seo":{"title":"Create a comment on an asset","description":"Create a new Comment for the specified Asset."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postAssetComments","name":"Create a comment on an asset","isWebhook":false,"pointer":"/paths/~1assets~1{id}~1comments/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a comment on an asset","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":"Create a new "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Asset-Comments"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Comment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the specified "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]}]}]}],"required":true}],"pointer":"/paths/~1assets~1{id}~1comments/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CommentRequest"}},"schemaId":"components/schemas/CommentRequest","pointer":"/paths/~1assets~1{id}~1comments/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/assets/{id}/comments","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CommentRequest"}},"responseCodes":["200","4XX"],"pointer":"/assets/{id}/comments","href":"asset-comments/postassetcomments","openApiOperationId":"postAssetComments","summary":"Create a comment on an asset"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/CommentRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CommentRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommentWithPermittedActions"}},"schemaId":"components/schemas/CommentWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1assets~1{id}~1comments/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommentWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommentWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/asset-comments/postassetcomments"}],"panels":[]}]},"httpPath":"/assets/{id}/comments"},{"label":"Update an asset comment","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/asset-comments/patchcomment","routeSlug":"/dash/openapi/asset-comments/patchcomment","metadata":{"seo":{"title":"Update an asset comment","description":"Patch a Comment"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchComment","name":"Update an asset comment","isWebhook":false,"pointer":"/paths/~1comments~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an asset comment","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":"Patch a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Asset-Comments"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Comment"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Asset-Comments"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Comment"},"children":[]}]}]}]}],"required":true}],"pointer":"/paths/~1comments~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CommentPatchRequest"}},"schemaId":"components/schemas/CommentPatchRequest","pointer":"/paths/~1comments~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/comments/{id}","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CommentPatchRequest"}},"responseCodes":["200","4XX"],"pointer":"/comments/{id}","href":"asset-comments/patchcomment","openApiOperationId":"patchComment","summary":"Update an asset comment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/CommentPatchRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CommentPatchRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommentWithPermittedActions"}},"schemaId":"components/schemas/CommentWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1comments~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommentWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommentWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/asset-comments/patchcomment"}],"panels":[]}]},"httpPath":"/comments/{id}"},{"label":"Delete an asset comment","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/asset-comments/deletecomment","routeSlug":"/dash/openapi/asset-comments/deletecomment","metadata":{"seo":{"title":"Delete an asset comment","description":"Delete a Comment resource."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteComment","name":"Delete an asset comment","isWebhook":false,"pointer":"/paths/~1comments~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an asset comment","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":"Delete a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Asset-Comments"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Comment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Asset-Comments"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Comment"},"children":[]}]}]}]}],"required":true}],"pointer":"/paths/~1comments~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/comments/{id}","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","4XX"],"pointer":"/comments/{id}","href":"asset-comments/deletecomment","openApiOperationId":"deleteComment","summary":"Delete an asset comment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1comments~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/asset-comments/deletecomment"}],"panels":[]}]},"httpPath":"/comments/{id}"}],"content":{"contentType":"group","meta":{"name":"Asset Comments"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Asset Comments","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Coming soon; "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"mailto:help@dash.app"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contact us"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if you need access to this API endpoint."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/assets/{id}/comments","summary":"Get an asset's comments","prefix":{"name":"get","color":"get"},"badges":[],"link":"/asset-comments/getassetcomments","deprecated":false},{"title":"/assets/{id}/comments","summary":"Create a comment on an asset","prefix":{"name":"post","color":"post"},"badges":[],"link":"/asset-comments/postassetcomments","deprecated":false},{"title":"/comments/{id}","summary":"Update an asset comment","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/asset-comments/patchcomment","deprecated":false},{"title":"/comments/{id}","summary":"Delete an asset comment","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/asset-comments/deletecomment","deprecated":false}]}]}]}]}},{"type":"group","label":"Asset Deduplication","link":"/dash/openapi/asset-deduplication","routeSlug":"/dash/openapi/asset-deduplication","items":[{"label":"Deduplicate all assets","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/asset-deduplication/postassetdeduplicationbatchjob","routeSlug":"/dash/openapi/asset-deduplication/postassetdeduplicationbatchjob","metadata":{"seo":{"title":"Deduplicate all assets","description":"Deduplicate duplicate Assets, where a duplicate is an asset with the same file checksum asanother asset. Duplicates are deleted. Metadata values from duplicates are merged into the original asset'smetadata. For metadata multivalues, e.g. folders, the total set of values is merged. For metadata text values, thelongest length text value is merged. For metadata date and date-time values, the oldest value is merged."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postAssetDeduplicationBatchJob","name":"Deduplicate all assets","isWebhook":false,"pointer":"/paths/~1asset-deduplication-batch-jobs/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deduplicate all assets","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":"Deduplicate duplicate "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Assets"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", where a duplicate is an asset with the same file checksum as"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"another asset. Duplicates are deleted. Metadata values from duplicates are merged into the original asset's"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"metadata. For metadata multivalues, e.g. folders, the total set of values is merged. For metadata text values, the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"longest length text value is merged. For metadata date and date-time values, the oldest value is merged."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/asset-deduplication-batch-jobs","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","4XX"],"pointer":"/asset-deduplication-batch-jobs","href":"asset-deduplication/postassetdeduplicationbatchjob","openApiOperationId":"postAssetDeduplicationBatchJob","summary":"Deduplicate all assets"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AssetDeduplicationBatchJob"}},"schemaId":"components/schemas/AssetDeduplicationBatchJob"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1asset-deduplication-batch-jobs/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AssetDeduplicationBatchJob","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AssetDeduplicationBatchJob"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/asset-deduplication/postassetdeduplicationbatchjob"}],"panels":[]}]},"httpPath":"/asset-deduplication-batch-jobs"},{"label":"Get the status of deduplicating assets","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/asset-deduplication/getassetdeduplicationbatchjob","routeSlug":"/dash/openapi/asset-deduplication/getassetdeduplicationbatchjob","metadata":{"seo":{"title":"Get the status of deduplicating assets","description":"Get the status and eventual result of an AssetDeduplicationJob"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAssetDeduplicationBatchJob","name":"Get the status of deduplicating assets","isWebhook":false,"pointer":"/paths/~1asset-deduplication-batch-jobs~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get the status of deduplicating assets","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":"Get the status and eventual result of an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/asset-deduplication/postassetdeduplicationbatchjob"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetDeduplicationJob"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/asset-deduplication/postassetdeduplicationbatchjob"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetDeduplicationJob"},"children":[]}]}]}]}],"required":true}],"pointer":"/paths/~1asset-deduplication-batch-jobs~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/asset-deduplication-batch-jobs/{id}","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","4XX"],"pointer":"/asset-deduplication-batch-jobs/{id}","href":"asset-deduplication/getassetdeduplicationbatchjob","openApiOperationId":"getAssetDeduplicationBatchJob","summary":"Get the status of deduplicating assets"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AssetDeduplicationBatchJob","exampleIds":["paths/~1asset-deduplication-batch-jobs~1{id}/get/responses/200/content/application~1json/examples/Completed"]}},"schemaId":"components/schemas/AssetDeduplicationBatchJob","exampleIds":["paths/~1asset-deduplication-batch-jobs~1{id}/get/responses/200/content/application~1json/examples/Completed"]},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1asset-deduplication-batch-jobs~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AssetDeduplicationBatchJob","exampleIds":["paths/~1asset-deduplication-batch-jobs~1{id}/get/responses/200/content/application~1json/examples/Completed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AssetDeduplicationBatchJob","exampleIds":["paths/~1asset-deduplication-batch-jobs~1{id}/get/responses/200/content/application~1json/examples/Completed"]}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/asset-deduplication/getassetdeduplicationbatchjob"}],"panels":[]}]},"httpPath":"/asset-deduplication-batch-jobs/{id}"}],"content":{"contentType":"group","meta":{"name":"Asset Deduplication"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Asset Deduplication","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Coming soon; "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"mailto:help@dash.app"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contact us"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if you need access to this API endpoint."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/asset-deduplication-batch-jobs","summary":"Deduplicate all assets","prefix":{"name":"post","color":"post"},"badges":[],"link":"/asset-deduplication/postassetdeduplicationbatchjob","deprecated":false},{"title":"/asset-deduplication-batch-jobs/{id}","summary":"Get the status of deduplicating assets","prefix":{"name":"get","color":"get"},"badges":[],"link":"/asset-deduplication/getassetdeduplicationbatchjob","deprecated":false}]}]}]}]}},{"type":"group","label":"Asset Embeddable Links","link":"/dash/openapi/asset-embeddable-links","routeSlug":"/dash/openapi/asset-embeddable-links","items":[{"label":"Update an asset embeddable link","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/asset-embeddable-links/embeddablelink","routeSlug":"/dash/openapi/asset-embeddable-links/embeddablelink","metadata":{"seo":{"title":"Update an asset embeddable link","description":"Update an AssetEmbeddableLink resource's status."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"EmbeddableLink","name":"Update an asset embeddable link","isWebhook":false,"pointer":"/paths/~1embeddable-links~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an asset embeddable link","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":"Update an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Asset-Embeddable-Links"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetEmbeddableLink"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource's status."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currently only a patch to status: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REVOKED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is supported."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This will update the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetEmbeddableLink"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource's status to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REVOKED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and fileStatus to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DELETED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Asset-Embeddable-Links"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetEmbeddableLink"},"children":[]}]}]}]}],"required":true}],"pointer":"/paths/~1embeddable-links~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EmbeddableLinkPatchRequest"}},"schemaId":"components/schemas/EmbeddableLinkPatchRequest","pointer":"/paths/~1embeddable-links~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/embeddable-links/{id}","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EmbeddableLinkPatchRequest"}},"responseCodes":["200","4XX"],"pointer":"/embeddable-links/{id}","href":"asset-embeddable-links/embeddablelink","openApiOperationId":"EmbeddableLink","summary":"Update an asset embeddable link"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/EmbeddableLinkPatchRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EmbeddableLinkPatchRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EmbeddableLinkWithPermittedActions"}},"schemaId":"components/schemas/EmbeddableLinkWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1embeddable-links~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/EmbeddableLinkWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EmbeddableLinkWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/asset-embeddable-links/embeddablelink"}],"panels":[]}]},"httpPath":"/embeddable-links/{id}"},{"label":"Create asset embeddable links","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/asset-embeddable-links/postassetembeddablelinkbatchjob","routeSlug":"/dash/openapi/asset-embeddable-links/postassetembeddablelinkbatchjob","metadata":{"seo":{"title":"Create asset embeddable links","description":"An AssetEmbeddableLinkBatchJob should be created when you want to create embeddable links for multiple AssetFile resources."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postAssetEmbeddableLinkBatchJob","name":"Create asset embeddable links","isWebhook":false,"pointer":"/paths/~1embeddable-link-batch-jobs/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create asset embeddable links","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":"An "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/asset-embeddable-links/postassetembeddablelinkbatchjob"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetEmbeddableLinkBatchJob"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" should be created when you want to create embeddable links for multiple "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/getassetfiles"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetFile"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There is a limit of 500 batch request items for this endpoint."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If more than 500 items are requested, the endpoint will error with a bad request(400) response."},"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":"transformationDescription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be one of two types, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CUSTOM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PRESET"},"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":"This definition and usage matches the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transformationDescription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" used in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/postassetdownloadbatchjob"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetDownloadBatchJob"},"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":"A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CUSTOM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transformationDescription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a list of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"candidateTransformations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" which are evaluated in turn against each "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/getassetfiles"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetFile"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" specified in the request."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/getassetfiles"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetFile"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"  meets the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"candidateTransformation.criteria"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" then the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"candidateTransformation.transformation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is applied. Otherwise, the next candidate is considered."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"candidateTransformation.transformation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a series of operations to apply to the  "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/getassetfiles"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetFile"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order (e.g. resize to 200 by 100  and then covert to JPG). An empty list of operations indicates the file should be left untransformed."},"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":"PRESET"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transformationDescription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is similar to a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CUSTOM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" transformation except the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transformationDescription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has been predefined."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These presets are currently only configurable via the Dash frontend, but can be found via a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/preset-transformations/postpresettransformationsearch"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PresetTransformationSearch"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EmbeddableLinkBatchRequest"}},"schemaId":"components/schemas/EmbeddableLinkBatchRequest","pointer":"/paths/~1embeddable-link-batch-jobs/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/embeddable-link-batch-jobs","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EmbeddableLinkBatchRequest"}},"responseCodes":["200","4XX"],"pointer":"/embeddable-link-batch-jobs","href":"asset-embeddable-links/postassetembeddablelinkbatchjob","openApiOperationId":"postAssetEmbeddableLinkBatchJob","summary":"Create asset embeddable links"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/EmbeddableLinkBatchRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EmbeddableLinkBatchRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EmbeddableLinkBatchJob","exampleIds":["paths/~1embeddable-link-batch-jobs/post/responses/200/content/application~1json/examples/In progress"]}},"schemaId":"components/schemas/EmbeddableLinkBatchJob","exampleIds":["paths/~1embeddable-link-batch-jobs/post/responses/200/content/application~1json/examples/In progress"]},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1embeddable-link-batch-jobs/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/EmbeddableLinkBatchJob","exampleIds":["paths/~1embeddable-link-batch-jobs/post/responses/200/content/application~1json/examples/In progress"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EmbeddableLinkBatchJob","exampleIds":["paths/~1embeddable-link-batch-jobs/post/responses/200/content/application~1json/examples/In progress"]}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/asset-embeddable-links/postassetembeddablelinkbatchjob"}],"panels":[]}]},"httpPath":"/embeddable-link-batch-jobs"},{"label":"Get the status of creating asset embeddable links","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/asset-embeddable-links/getassetembeddablelinkbatchjob","routeSlug":"/dash/openapi/asset-embeddable-links/getassetembeddablelinkbatchjob","metadata":{"seo":{"title":"Get the status of creating asset embeddable links","description":"Get the status and eventual result of an AssetEmbeddableLinkBatchJob"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAssetEmbeddableLinkBatchJob","name":"Get the status of creating asset embeddable links","isWebhook":false,"pointer":"/paths/~1embeddable-link-batch-jobs~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get the status of creating asset embeddable links","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":"Get the status and eventual result of an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/asset-embeddable-links/postassetembeddablelinkbatchjob"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetEmbeddableLinkBatchJob"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/asset-embeddable-links/postassetembeddablelinkbatchjob"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetEmbeddableLinkBatchJob"},"children":[]}]}]}]}],"required":true}],"pointer":"/paths/~1embeddable-link-batch-jobs~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/embeddable-link-batch-jobs/{id}","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","4XX"],"pointer":"/embeddable-link-batch-jobs/{id}","href":"asset-embeddable-links/getassetembeddablelinkbatchjob","openApiOperationId":"getAssetEmbeddableLinkBatchJob","summary":"Get the status of creating asset embeddable links"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EmbeddableLinkBatchJob"}},"schemaId":"components/schemas/EmbeddableLinkBatchJob"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1embeddable-link-batch-jobs~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/EmbeddableLinkBatchJob","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EmbeddableLinkBatchJob"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/asset-embeddable-links/getassetembeddablelinkbatchjob"}],"panels":[]}]},"httpPath":"/embeddable-link-batch-jobs/{id}"},{"label":"Discard creating asset embeddable links","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/asset-embeddable-links/deleteassetembeddablelinkbatchjob","routeSlug":"/dash/openapi/asset-embeddable-links/deleteassetembeddablelinkbatchjob","metadata":{"seo":{"title":"Discard creating asset embeddable links","description":"Stops an AssetEmbeddableLinkBatchJob and deletes it"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteAssetEmbeddableLinkBatchJob","name":"Discard creating asset embeddable links","isWebhook":false,"pointer":"/paths/~1embeddable-link-batch-jobs~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Discard creating asset embeddable links","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":"Stops an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/asset-embeddable-links/postassetembeddablelinkbatchjob"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetEmbeddableLinkBatchJob"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and deletes it"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/asset-embeddable-links/postassetembeddablelinkbatchjob"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetEmbeddableLinkBatchJob"},"children":[]}]}]}]}],"required":true}],"pointer":"/paths/~1embeddable-link-batch-jobs~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/embeddable-link-batch-jobs/{id}","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","4XX"],"pointer":"/embeddable-link-batch-jobs/{id}","href":"asset-embeddable-links/deleteassetembeddablelinkbatchjob","openApiOperationId":"deleteAssetEmbeddableLinkBatchJob","summary":"Discard creating asset embeddable links"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1embeddable-link-batch-jobs~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/asset-embeddable-links/deleteassetembeddablelinkbatchjob"}],"panels":[]}]},"httpPath":"/embeddable-link-batch-jobs/{id}"},{"label":"Search for asset embeddable links","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/asset-embeddable-links/postembeddablelinksearches","routeSlug":"/dash/openapi/asset-embeddable-links/postembeddablelinksearches","metadata":{"seo":{"title":"Search for asset embeddable links","description":"Create a new AssetEmbeddableLinkSearch.The criterion and sort currently support search by ASSET_ID field only."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postEmbeddableLinkSearches","name":"Search for asset embeddable links","isWebhook":false,"pointer":"/paths/~1embeddable-link-searches/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search for asset embeddable links","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":"Create a new "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/asset-embeddable-links/postembeddablelinksearches"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetEmbeddableLinkSearch"},"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":"The criterion and sort currently support search by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ASSET_ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field only."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EmbeddableLinkSearchRequest"}},"schemaId":"components/schemas/EmbeddableLinkSearchRequest","pointer":"/paths/~1embeddable-link-searches/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/embeddable-link-searches","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EmbeddableLinkSearchRequest"}},"responseCodes":["200","4XX"],"pointer":"/embeddable-link-searches","href":"asset-embeddable-links/postembeddablelinksearches","openApiOperationId":"postEmbeddableLinkSearches","summary":"Search for asset embeddable links"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/EmbeddableLinkSearchRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EmbeddableLinkSearchRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EmbeddableLinkSearch"}},"schemaId":"components/schemas/EmbeddableLinkSearch"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1embeddable-link-searches/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/EmbeddableLinkSearch","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EmbeddableLinkSearch"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/asset-embeddable-links/postembeddablelinksearches"}],"panels":[]}]},"httpPath":"/embeddable-link-searches"}],"content":{"contentType":"group","meta":{"name":"Asset Embeddable Links"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Asset Embeddable Links","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Embeddable Links provide a way to get a public (although unguessable) link to an optionally transformed "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/getassetfiles"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetFile"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/embeddable-links/{id}","summary":"Update an asset embeddable link","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/asset-embeddable-links/embeddablelink","deprecated":false},{"title":"/embeddable-link-batch-jobs","summary":"Create asset embeddable links","prefix":{"name":"post","color":"post"},"badges":[],"link":"/asset-embeddable-links/postassetembeddablelinkbatchjob","deprecated":false},{"title":"/embeddable-link-batch-jobs/{id}","summary":"Get the status of creating asset embeddable links","prefix":{"name":"get","color":"get"},"badges":[],"link":"/asset-embeddable-links/getassetembeddablelinkbatchjob","deprecated":false},{"title":"/embeddable-link-batch-jobs/{id}","summary":"Discard creating asset embeddable links","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/asset-embeddable-links/deleteassetembeddablelinkbatchjob","deprecated":false},{"title":"/embeddable-link-searches","summary":"Search for asset embeddable links","prefix":{"name":"post","color":"post"},"badges":[],"link":"/asset-embeddable-links/postembeddablelinksearches","deprecated":false}]}]}]}]}},{"type":"group","label":"Asset Metadata Export","link":"/dash/openapi/asset-metadata-export","routeSlug":"/dash/openapi/asset-metadata-export","items":[{"label":"Export assets' metadata","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/asset-metadata-export/postmetadataexportbatchjob","routeSlug":"/dash/openapi/asset-metadata-export/postmetadataexportbatchjob","metadata":{"seo":{"title":"Export assets' metadata","description":"Export the metadata of all Assets to a CSV file"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postMetadataExportBatchJob","name":"Export assets' metadata","isWebhook":false,"pointer":"/paths/~1asset-metadata-export-batch-jobs/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Export assets' metadata","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":"Export the metadata of all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"s to a CSV file"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/asset-metadata-export-batch-jobs","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","4XX"],"pointer":"/asset-metadata-export-batch-jobs","href":"asset-metadata-export/postmetadataexportbatchjob","openApiOperationId":"postMetadataExportBatchJob","summary":"Export assets' metadata"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MetadataExportBatchJob"}},"schemaId":"components/schemas/MetadataExportBatchJob"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1asset-metadata-export-batch-jobs/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/MetadataExportBatchJob","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MetadataExportBatchJob"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/asset-metadata-export/postmetadataexportbatchjob"}],"panels":[]}]},"httpPath":"/asset-metadata-export-batch-jobs"},{"label":"Get the status of exporting assets' metadata","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/asset-metadata-export/getmetadataexportbatchjob","routeSlug":"/dash/openapi/asset-metadata-export/getmetadataexportbatchjob","metadata":{"seo":{"title":"Get the status of exporting assets' metadata","description":"Get the status and eventual result of a MetadataExportJob"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getMetadataExportBatchJob","name":"Get the status of exporting assets' metadata","isWebhook":false,"pointer":"/paths/~1asset-metadata-export-batch-jobs~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get the status of exporting assets' metadata","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":"Get the status and eventual result of a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/asset-metadata-export/postmetadataexportbatchjob"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MetadataExportJob"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/asset-metadata-export/postmetadataexportbatchjob"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MetadataExportJob"},"children":[]}]}]}]}],"required":true}],"pointer":"/paths/~1asset-metadata-export-batch-jobs~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/asset-metadata-export-batch-jobs/{id}","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","4XX"],"pointer":"/asset-metadata-export-batch-jobs/{id}","href":"asset-metadata-export/getmetadataexportbatchjob","openApiOperationId":"getMetadataExportBatchJob","summary":"Get the status of exporting assets' metadata"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MetadataExportBatchJob","exampleIds":["paths/~1asset-metadata-export-batch-jobs~1{id}/get/responses/200/content/application~1json/examples/Completed"]}},"schemaId":"components/schemas/MetadataExportBatchJob","exampleIds":["paths/~1asset-metadata-export-batch-jobs~1{id}/get/responses/200/content/application~1json/examples/Completed"]},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1asset-metadata-export-batch-jobs~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/MetadataExportBatchJob","exampleIds":["paths/~1asset-metadata-export-batch-jobs~1{id}/get/responses/200/content/application~1json/examples/Completed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MetadataExportBatchJob","exampleIds":["paths/~1asset-metadata-export-batch-jobs~1{id}/get/responses/200/content/application~1json/examples/Completed"]}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/asset-metadata-export/getmetadataexportbatchjob"}],"panels":[]}]},"httpPath":"/asset-metadata-export-batch-jobs/{id}"},{"label":"Update the status of exporting assets' metadata","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/asset-metadata-export/patchmetadataexportbatchjob","routeSlug":"/dash/openapi/asset-metadata-export/patchmetadataexportbatchjob","metadata":{"seo":{"title":"Update the status of exporting assets' metadata","description":"Update a MetadataExportJob"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchMetadataExportBatchJob","name":"Update the status of exporting assets' metadata","isWebhook":false,"pointer":"/paths/~1asset-metadata-export-batch-jobs~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update the status of exporting assets' metadata","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":"Update a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/asset-metadata-export/postmetadataexportbatchjob"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MetadataExportJob"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/asset-metadata-export/postmetadataexportbatchjob"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MetadataExportJob"},"children":[]}]}]}]}],"required":true}],"pointer":"/paths/~1asset-metadata-export-batch-jobs~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/JobPatchRequest"}},"schemaId":"components/schemas/JobPatchRequest","pointer":"/paths/~1asset-metadata-export-batch-jobs~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/asset-metadata-export-batch-jobs/{id}","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/JobPatchRequest"}},"responseCodes":["200","4XX"],"pointer":"/asset-metadata-export-batch-jobs/{id}","href":"asset-metadata-export/patchmetadataexportbatchjob","openApiOperationId":"patchMetadataExportBatchJob","summary":"Update the status of exporting assets' metadata"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/JobPatchRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/JobPatchRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MetadataExportBatchJob","exampleIds":["paths/~1asset-metadata-export-batch-jobs~1{id}/patch/responses/200/content/application~1json/examples/Completed"]}},"schemaId":"components/schemas/MetadataExportBatchJob","exampleIds":["paths/~1asset-metadata-export-batch-jobs~1{id}/patch/responses/200/content/application~1json/examples/Completed"]},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1asset-metadata-export-batch-jobs~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/MetadataExportBatchJob","exampleIds":["paths/~1asset-metadata-export-batch-jobs~1{id}/patch/responses/200/content/application~1json/examples/Completed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MetadataExportBatchJob","exampleIds":["paths/~1asset-metadata-export-batch-jobs~1{id}/patch/responses/200/content/application~1json/examples/Completed"]}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/asset-metadata-export/patchmetadataexportbatchjob"}],"panels":[]}]},"httpPath":"/asset-metadata-export-batch-jobs/{id}"},{"label":"Discard exporting assets' metadata","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/asset-metadata-export/deletemetadataexportbatchjob","routeSlug":"/dash/openapi/asset-metadata-export/deletemetadataexportbatchjob","metadata":{"seo":{"title":"Discard exporting assets' metadata","description":"Stops a MetadataExportJob and deletes it"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteMetadataExportBatchJob","name":"Discard exporting assets' metadata","isWebhook":false,"pointer":"/paths/~1asset-metadata-export-batch-jobs~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Discard exporting assets' metadata","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":"Stops a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/asset-metadata-export/postmetadataexportbatchjob"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MetadataExportJob"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and deletes it"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/asset-metadata-export/postmetadataexportbatchjob"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MetadataExportJob"},"children":[]}]}]}]}],"required":true}],"pointer":"/paths/~1asset-metadata-export-batch-jobs~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/asset-metadata-export-batch-jobs/{id}","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","4XX"],"pointer":"/asset-metadata-export-batch-jobs/{id}","href":"asset-metadata-export/deletemetadataexportbatchjob","openApiOperationId":"deleteMetadataExportBatchJob","summary":"Discard exporting assets' metadata"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1asset-metadata-export-batch-jobs~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/asset-metadata-export/deletemetadataexportbatchjob"}],"panels":[]}]},"httpPath":"/asset-metadata-export-batch-jobs/{id}"}],"content":{"contentType":"group","meta":{"name":"Asset Metadata Export"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Asset Metadata Export","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Coming soon; "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"mailto:help@dash.app"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contact us"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if you need access to this API endpoint."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/asset-metadata-export-batch-jobs","summary":"Export assets' metadata","prefix":{"name":"post","color":"post"},"badges":[],"link":"/asset-metadata-export/postmetadataexportbatchjob","deprecated":false},{"title":"/asset-metadata-export-batch-jobs/{id}","summary":"Get the status of exporting assets' metadata","prefix":{"name":"get","color":"get"},"badges":[],"link":"/asset-metadata-export/getmetadataexportbatchjob","deprecated":false},{"title":"/asset-metadata-export-batch-jobs/{id}","summary":"Update the status of exporting assets' metadata","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/asset-metadata-export/patchmetadataexportbatchjob","deprecated":false},{"title":"/asset-metadata-export-batch-jobs/{id}","summary":"Discard exporting assets' metadata","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/asset-metadata-export/deletemetadataexportbatchjob","deprecated":false}]}]}]}]}},{"type":"group","label":"Asset Saved Crop Area Summaries","link":"/dash/openapi/asset-saved-crop-area-summaries","routeSlug":"/dash/openapi/asset-saved-crop-area-summaries","items":[{"label":"Get an asset's saved crop area summaries","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/asset-saved-crop-area-summaries/getsavedcropareasummaries","routeSlug":"/dash/openapi/asset-saved-crop-area-summaries/getsavedcropareasummaries","metadata":{"seo":{"title":"Get an asset's saved crop area summaries","description":"Get all of the SavedCropAreaSummaries resources for the specified Asset."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSavedCropAreaSummaries","name":"Get an asset's saved crop area summaries","isWebhook":false,"pointer":"/paths/~1assets~1{id}~1saved-crop-area-summaries/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get an asset's saved crop area summaries","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":"Get all of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Asset-Saved-Crop-Areas"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SavedCropAreaSummaries"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources for the specified "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Asset"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]}]}]}],"required":true}],"pointer":"/paths/~1assets~1{id}~1saved-crop-area-summaries/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/assets/{id}/saved-crop-area-summaries","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","4XX"],"pointer":"/assets/{id}/saved-crop-area-summaries","href":"asset-saved-crop-area-summaries/getsavedcropareasummaries","openApiOperationId":"getSavedCropAreaSummaries","summary":"Get an asset's saved crop area summaries"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_29"}},"schemaId":"schema_29"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1assets~1{id}~1saved-crop-area-summaries/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_29","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_29"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/asset-saved-crop-area-summaries/getsavedcropareasummaries"}],"panels":[]}]},"httpPath":"/assets/{id}/saved-crop-area-summaries"},{"label":"Search for asset saved crop area summaries","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/asset-saved-crop-area-summaries/postassetsavedcropareasummarysearch","routeSlug":"/dash/openapi/asset-saved-crop-area-summaries/postassetsavedcropareasummarysearch","metadata":{"seo":{"title":"Search for asset saved crop area summaries","description":"Create a new Asset Saved Crop Area Summary Search"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postAssetSavedCropAreaSummarySearch","name":"Search for asset saved crop area summaries","isWebhook":false,"pointer":"/paths/~1asset-saved-crop-area-summary-searches/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search for asset saved crop area summaries","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":"Create a new "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/asset-saved-crop-area-summaries/postassetsavedcropareasummarysearch"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset Saved Crop Area Summary Search"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SavedCropAreaSummarySearchRequest"}},"schemaId":"components/schemas/SavedCropAreaSummarySearchRequest","pointer":"/paths/~1asset-saved-crop-area-summary-searches/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/asset-saved-crop-area-summary-searches","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SavedCropAreaSummarySearchRequest"}},"responseCodes":["200","4XX"],"pointer":"/asset-saved-crop-area-summary-searches","href":"asset-saved-crop-area-summaries/postassetsavedcropareasummarysearch","openApiOperationId":"postAssetSavedCropAreaSummarySearch","summary":"Search for asset saved crop area summaries"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/SavedCropAreaSummarySearchRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SavedCropAreaSummarySearchRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SavedCropAreaSummarySearch"}},"schemaId":"components/schemas/SavedCropAreaSummarySearch"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1asset-saved-crop-area-summary-searches/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SavedCropAreaSummarySearch","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SavedCropAreaSummarySearch"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/asset-saved-crop-area-summaries/postassetsavedcropareasummarysearch"}],"panels":[]}]},"httpPath":"/asset-saved-crop-area-summary-searches"}],"content":{"contentType":"group","meta":{"name":"Asset Saved Crop Area Summaries"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Asset Saved Crop Area Summaries","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Asset-Saved-Crop-Area-Summaries"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset Saved Crop Area Summary"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource is a saved crop area summary for a given "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/getassetfiles"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetFile"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/assets/{id}/saved-crop-area-summaries","summary":"Get an asset's saved crop area summaries","prefix":{"name":"get","color":"get"},"badges":[],"link":"/asset-saved-crop-area-summaries/getsavedcropareasummaries","deprecated":false},{"title":"/asset-saved-crop-area-summary-searches","summary":"Search for asset saved crop area summaries","prefix":{"name":"post","color":"post"},"badges":[],"link":"/asset-saved-crop-area-summaries/postassetsavedcropareasummarysearch","deprecated":false}]}]}]}]}},{"type":"group","label":"Asset Saved Crop Areas","link":"/dash/openapi/asset-saved-crop-areas","routeSlug":"/dash/openapi/asset-saved-crop-areas","items":[{"label":"Create a saved crop area for an asset","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/asset-saved-crop-areas/postsavedcroparea","routeSlug":"/dash/openapi/asset-saved-crop-areas/postsavedcroparea","metadata":{"seo":{"title":"Create a saved crop area for an asset","description":"Create a SavedCropArea for the specified Asset."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postSavedCropArea","name":"Create a saved crop area for an asset","isWebhook":false,"pointer":"/paths/~1assets~1{id}~1saved-crop-areas/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a saved crop area for an asset","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":"Create a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Asset-Saved-Crop-Areas"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SavedCropArea"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the specified "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Asset"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]}]}]}],"required":true}],"pointer":"/paths/~1assets~1{id}~1saved-crop-areas/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SavedCropAreaRequest"}},"schemaId":"components/schemas/SavedCropAreaRequest","pointer":"/paths/~1assets~1{id}~1saved-crop-areas/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/assets/{id}/saved-crop-areas","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SavedCropAreaRequest"}},"responseCodes":["200","4XX"],"pointer":"/assets/{id}/saved-crop-areas","href":"asset-saved-crop-areas/postsavedcroparea","openApiOperationId":"postSavedCropArea","summary":"Create a saved crop area for an asset"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/SavedCropAreaRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SavedCropAreaRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SavedCropAreaWithPermittedActions"}},"schemaId":"components/schemas/SavedCropAreaWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1assets~1{id}~1saved-crop-areas/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SavedCropAreaWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SavedCropAreaWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/asset-saved-crop-areas/postsavedcroparea"}],"panels":[]}]},"httpPath":"/assets/{id}/saved-crop-areas"},{"label":"Get a saved crop area","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/asset-saved-crop-areas/getsavedcroparea","routeSlug":"/dash/openapi/asset-saved-crop-areas/getsavedcroparea","metadata":{"seo":{"title":"Get a saved crop area","description":"Get a SavedCropArea resource."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSavedCropArea","name":"Get a saved crop area","isWebhook":false,"pointer":"/paths/~1asset-saved-crop-areas~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a saved crop area","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":"Get a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Asset-Saved-Crop-Areas"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SavedCropArea"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Asset-Saved-Crop-Areas"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SavedCropArea"},"children":[]}]}]}]}],"required":true}],"pointer":"/paths/~1asset-saved-crop-areas~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/asset-saved-crop-areas/{id}","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","4XX"],"pointer":"/asset-saved-crop-areas/{id}","href":"asset-saved-crop-areas/getsavedcroparea","openApiOperationId":"getSavedCropArea","summary":"Get a saved crop area"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SavedCropAreaWithPermittedActions"}},"schemaId":"components/schemas/SavedCropAreaWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1asset-saved-crop-areas~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SavedCropAreaWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SavedCropAreaWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/asset-saved-crop-areas/getsavedcroparea"}],"panels":[]}]},"httpPath":"/asset-saved-crop-areas/{id}"},{"label":"Update a saved crop area","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/asset-saved-crop-areas/patchsavedcroparea","routeSlug":"/dash/openapi/asset-saved-crop-areas/patchsavedcroparea","metadata":{"seo":{"title":"Update a saved crop area","description":"Update a SavedCropArea resource. Only the provided fields will be updated"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchSavedCropArea","name":"Update a saved crop area","isWebhook":false,"pointer":"/paths/~1asset-saved-crop-areas~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a saved crop area","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":"Update a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Asset-Saved-Crop-Areas"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SavedCropArea"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource. Only the provided fields will be updated"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Asset-Saved-Crop-Areas"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SavedCropArea"},"children":[]}]}]}]}],"required":true}],"pointer":"/paths/~1asset-saved-crop-areas~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SavedCropAreaPatchRequest"}},"schemaId":"components/schemas/SavedCropAreaPatchRequest","pointer":"/paths/~1asset-saved-crop-areas~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/asset-saved-crop-areas/{id}","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SavedCropAreaPatchRequest"}},"responseCodes":["200","4XX"],"pointer":"/asset-saved-crop-areas/{id}","href":"asset-saved-crop-areas/patchsavedcroparea","openApiOperationId":"patchSavedCropArea","summary":"Update a saved crop area"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/SavedCropAreaPatchRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SavedCropAreaPatchRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SavedCropAreaWithPermittedActions"}},"schemaId":"components/schemas/SavedCropAreaWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1asset-saved-crop-areas~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SavedCropAreaWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SavedCropAreaWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/asset-saved-crop-areas/patchsavedcroparea"}],"panels":[]}]},"httpPath":"/asset-saved-crop-areas/{id}"},{"label":"Delete a Saved Crop Area","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/asset-saved-crop-areas/deletesavedcroparea","routeSlug":"/dash/openapi/asset-saved-crop-areas/deletesavedcroparea","metadata":{"seo":{"title":"Delete a Saved Crop Area","description":"Delete a SavedCropArea resource."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteSavedCropArea","name":"Delete a Saved Crop Area","isWebhook":false,"pointer":"/paths/~1asset-saved-crop-areas~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a Saved Crop Area","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":"Delete a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Asset-Saved-Crop-Areas"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SavedCropArea"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Asset-Saved-Crop-Areas"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SavedCropArea"},"children":[]}]}]}]}],"required":true}],"pointer":"/paths/~1asset-saved-crop-areas~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/asset-saved-crop-areas/{id}","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","4XX"],"pointer":"/asset-saved-crop-areas/{id}","href":"asset-saved-crop-areas/deletesavedcroparea","openApiOperationId":"deleteSavedCropArea","summary":"Delete a Saved Crop Area"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1asset-saved-crop-areas~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/asset-saved-crop-areas/deletesavedcroparea"}],"panels":[]}]},"httpPath":"/asset-saved-crop-areas/{id}"}],"content":{"contentType":"group","meta":{"name":"Asset Saved Crop Areas"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Asset Saved Crop Areas","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Asset-Saved-Crop-Areas"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset Saved Crop Area"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource is a saved crop area for a given "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/getassetfiles"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetFile"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/assets/{id}/saved-crop-areas","summary":"Create a saved crop area for an asset","prefix":{"name":"post","color":"post"},"badges":[],"link":"/asset-saved-crop-areas/postsavedcroparea","deprecated":false},{"title":"/asset-saved-crop-areas/{id}","summary":"Get a saved crop area","prefix":{"name":"get","color":"get"},"badges":[],"link":"/asset-saved-crop-areas/getsavedcroparea","deprecated":false},{"title":"/asset-saved-crop-areas/{id}","summary":"Update a saved crop area","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/asset-saved-crop-areas/patchsavedcroparea","deprecated":false},{"title":"/asset-saved-crop-areas/{id}","summary":"Delete a Saved Crop Area","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/asset-saved-crop-areas/deletesavedcroparea","deprecated":false}]}]}]}]}},{"type":"group","label":"Asset Variant Criteria","link":"/dash/openapi/asset-variant-criteria","routeSlug":"/dash/openapi/asset-variant-criteria","items":[{"label":"Get an asset variant criterion","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/asset-variant-criteria/getassetvariantcriterion","routeSlug":"/dash/openapi/asset-variant-criteria/getassetvariantcriterion","metadata":{"seo":{"title":"Get an asset variant criterion","description":"Get an AssetVariantCriterion resource."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAssetVariantCriterion","name":"Get an asset variant criterion","isWebhook":false,"pointer":"/paths/~1asset-variant-criteria~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get an asset variant criterion","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":"Get an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Asset-Variant-Criteria"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetVariantCriterion"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Asset-Variant-Criteria"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetVariantCriterion"},"children":[]}]}]}]}],"required":true,"example":"e5e4b297-29e7-4a78-8f9f-97f7a02df8df"}],"pointer":"/paths/~1asset-variant-criteria~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/asset-variant-criteria/{id}","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"e5e4b297-29e7-4a78-8f9f-97f7a02df8df","schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","4XX"],"pointer":"/asset-variant-criteria/{id}","href":"asset-variant-criteria/getassetvariantcriterion","openApiOperationId":"getAssetVariantCriterion","summary":"Get an asset variant criterion"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AssetVariantCriterionWithPermittedActions","exampleIds":["paths/~1asset-variant-criteria~1{id}/get/responses/200/content/application~1json/examples/For selected product variant values"]}},"schemaId":"components/schemas/AssetVariantCriterionWithPermittedActions","exampleIds":["paths/~1asset-variant-criteria~1{id}/get/responses/200/content/application~1json/examples/For selected product variant values"]},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1asset-variant-criteria~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AssetVariantCriterionWithPermittedActions","exampleIds":["paths/~1asset-variant-criteria~1{id}/get/responses/200/content/application~1json/examples/For selected product variant values"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AssetVariantCriterionWithPermittedActions","exampleIds":["paths/~1asset-variant-criteria~1{id}/get/responses/200/content/application~1json/examples/For selected product variant values"]}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/asset-variant-criteria/getassetvariantcriterion"}],"panels":[]}]},"httpPath":"/asset-variant-criteria/{id}"},{"label":"Search for asset variant criteria","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/asset-variant-criteria/postassetvariantcriterionsearch","routeSlug":"/dash/openapi/asset-variant-criteria/postassetvariantcriterionsearch","metadata":{"seo":{"title":"Search for asset variant criteria","description":"Create a new AssetVariantCriterionSearch"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postAssetVariantCriterionSearch","name":"Search for asset variant criteria","isWebhook":false,"pointer":"/paths/~1asset-variant-criterion-searches/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search for asset variant criteria","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":"Create a new "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/asset-variant-criteria/postassetvariantcriterionsearch"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetVariantCriterionSearch"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AssetVariantCriterionSearchRequest"}},"schemaId":"components/schemas/AssetVariantCriterionSearchRequest","pointer":"/paths/~1asset-variant-criterion-searches/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/asset-variant-criterion-searches","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AssetVariantCriterionSearchRequest"}},"responseCodes":["200","4XX"],"pointer":"/asset-variant-criterion-searches","href":"asset-variant-criteria/postassetvariantcriterionsearch","openApiOperationId":"postAssetVariantCriterionSearch","summary":"Search for asset variant criteria"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/AssetVariantCriterionSearchRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AssetVariantCriterionSearchRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AssetVariantCriterionSearch"}},"schemaId":"components/schemas/AssetVariantCriterionSearch"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1asset-variant-criterion-searches/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AssetVariantCriterionSearch","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AssetVariantCriterionSearch"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/asset-variant-criteria/postassetvariantcriterionsearch"}],"panels":[]}]},"httpPath":"/asset-variant-criterion-searches"}],"content":{"contentType":"group","meta":{"name":"Asset Variant Criteria"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Asset Variant Criteria","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Asset-Variant-Criteria"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetVariantCriterion"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource associates an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with product variants."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/asset-variant-criteria/{id}","summary":"Get an asset variant criterion","prefix":{"name":"get","color":"get"},"badges":[],"link":"/asset-variant-criteria/getassetvariantcriterion","deprecated":false},{"title":"/asset-variant-criterion-searches","summary":"Search for asset variant criteria","prefix":{"name":"post","color":"post"},"badges":[],"link":"/asset-variant-criteria/postassetvariantcriterionsearch","deprecated":false}]}]}]}]}},{"type":"separator","label":"Asset Share","content":null},{"type":"group","label":"Asset Shares","link":"/dash/openapi/asset-shares","routeSlug":"/dash/openapi/asset-shares","items":[{"label":"Create an asset share","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/asset-shares/createassetshare","routeSlug":"/dash/openapi/asset-shares/createassetshare","metadata":{"seo":{"title":"Create an asset share","description":"Create an AssetShare."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createAssetShare","name":"Create an asset share","isWebhook":false,"pointer":"/paths/~1asset-shares/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an asset share","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":"Create an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Asset-Shares"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetShare"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AssetShareRequest"}},"schemaId":"components/schemas/AssetShareRequest","pointer":"/paths/~1asset-shares/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/asset-shares","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AssetShareRequest"}},"responseCodes":["200","4XX"],"pointer":"/asset-shares","href":"asset-shares/createassetshare","openApiOperationId":"createAssetShare","summary":"Create an asset share"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/AssetShareRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AssetShareRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AssetShareWithPermittedActions"}},"schemaId":"components/schemas/AssetShareWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1asset-shares/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AssetShareWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AssetShareWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/asset-shares/createassetshare"}],"panels":[]}]},"httpPath":"/asset-shares"},{"label":"Get an asset share","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/asset-shares/getassetshare","routeSlug":"/dash/openapi/asset-shares/getassetshare","metadata":{"seo":{"title":"Get an asset share","description":"Get an AssetShare"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAssetShare","name":"Get an asset share","isWebhook":false,"pointer":"/paths/~1asset-shares~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get an asset share","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":"Get an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Asset-Shares"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetShare"},"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":"This endpoint is unauthenticated. Do not send a Bearer Token in the Authorization Header"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Asset-Shares"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetShare"},"children":[]}]}]}]}],"required":true}],"pointer":"/paths/~1asset-shares~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/asset-shares/{id}","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","4XX"],"pointer":"/asset-shares/{id}","href":"asset-shares/getassetshare","openApiOperationId":"getAssetShare","summary":"Get an asset share"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AssetShareWithPermittedActions"}},"schemaId":"components/schemas/AssetShareWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1asset-shares~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AssetShareWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AssetShareWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/asset-shares/getassetshare"}],"panels":[]}]},"httpPath":"/asset-shares/{id}"},{"label":"Update an asset share","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/asset-shares/patchassetshare","routeSlug":"/dash/openapi/asset-shares/patchassetshare","metadata":{"seo":{"title":"Update an asset share","description":"Patch an AssetShare"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchAssetShare","name":"Update an asset share","isWebhook":false,"pointer":"/paths/~1asset-shares~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an asset share","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":"Patch an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Asset-Shares"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetShare"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Asset-Shares"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetShare"},"children":[]}]}]}]}],"required":true}],"pointer":"/paths/~1asset-shares~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AssetSharePatchRequest"}},"schemaId":"components/schemas/AssetSharePatchRequest","pointer":"/paths/~1asset-shares~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/asset-shares/{id}","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AssetSharePatchRequest"}},"responseCodes":["200","4XX"],"pointer":"/asset-shares/{id}","href":"asset-shares/patchassetshare","openApiOperationId":"patchAssetShare","summary":"Update an asset share"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/AssetSharePatchRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AssetSharePatchRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AssetShareWithPermittedActions"}},"schemaId":"components/schemas/AssetShareWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1asset-shares~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AssetShareWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AssetShareWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/asset-shares/patchassetshare"}],"panels":[]}]},"httpPath":"/asset-shares/{id}"},{"label":"Delete an asset share","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/asset-shares/deleteassetshare","routeSlug":"/dash/openapi/asset-shares/deleteassetshare","metadata":{"seo":{"title":"Delete an asset share","description":"Delete an AssetShare resource."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteAssetShare","name":"Delete an asset share","isWebhook":false,"pointer":"/paths/~1asset-shares~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an asset share","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":"Delete an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Asset-Shares"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetShare"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Asset-Shares"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetShare"},"children":[]}]}]}]}],"required":true}],"pointer":"/paths/~1asset-shares~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/asset-shares/{id}","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","4XX"],"pointer":"/asset-shares/{id}","href":"asset-shares/deleteassetshare","openApiOperationId":"deleteAssetShare","summary":"Delete an asset share"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1asset-shares~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/asset-shares/deleteassetshare"}],"panels":[]}]},"httpPath":"/asset-shares/{id}"},{"label":"Search for asset shares","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/asset-shares/postassetsharesearch","routeSlug":"/dash/openapi/asset-shares/postassetsharesearch","metadata":{"seo":{"title":"Search for asset shares","description":"Create a new AssetShareSearch"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postAssetShareSearch","name":"Search for asset shares","isWebhook":false,"pointer":"/paths/~1asset-share-searches/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search for asset shares","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":"Create a new "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/asset-shares/postassetsharesearch"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetShareSearch"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AssetShareSearchRequest"}},"schemaId":"components/schemas/AssetShareSearchRequest","pointer":"/paths/~1asset-share-searches/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/asset-share-searches","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AssetShareSearchRequest"}},"responseCodes":["200","4XX"],"pointer":"/asset-share-searches","href":"asset-shares/postassetsharesearch","openApiOperationId":"postAssetShareSearch","summary":"Search for asset shares"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/AssetShareSearchRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AssetShareSearchRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AssetShareSearch"}},"schemaId":"components/schemas/AssetShareSearch"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1asset-share-searches/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AssetShareSearch","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AssetShareSearch"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/asset-shares/postassetsharesearch"}],"panels":[]}]},"httpPath":"/asset-share-searches"}],"content":{"contentType":"group","meta":{"name":"Asset Shares"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Asset Shares","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Asset-Shares"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetShare"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource is a set of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Assets"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" which has been publicly shared. This can be for a limited period of time or forever."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The assets shared can be view only or can also be downloaded."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/asset-shares","summary":"Create an asset share","prefix":{"name":"post","color":"post"},"badges":[],"link":"/asset-shares/createassetshare","deprecated":false},{"title":"/asset-shares/{id}","summary":"Get an asset share","prefix":{"name":"get","color":"get"},"badges":[],"link":"/asset-shares/getassetshare","deprecated":false},{"title":"/asset-shares/{id}","summary":"Update an asset share","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/asset-shares/patchassetshare","deprecated":false},{"title":"/asset-shares/{id}","summary":"Delete an asset share","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/asset-shares/deleteassetshare","deprecated":false},{"title":"/asset-share-searches","summary":"Search for asset shares","prefix":{"name":"post","color":"post"},"badges":[],"link":"/asset-shares/postassetsharesearch","deprecated":false}]}]}]}]}},{"type":"group","label":"Asset Share Access Tokens","link":"/dash/openapi/asset-share-access-tokens","routeSlug":"/dash/openapi/asset-share-access-tokens","items":[{"label":"Get an asset share access token","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/asset-share-access-tokens/getassetshareaccesstoken","routeSlug":"/dash/openapi/asset-share-access-tokens/getassetshareaccesstoken","metadata":{"seo":{"title":"Get an asset share access token","description":"Get an access token for viewing data which has been shared as part of the AssetShare.  Use this access token in the same way as the normal signed-in user token to make requests with the permissions of the share applied."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAssetShareAccessToken","name":"Get an asset share access token","isWebhook":false,"pointer":"/paths/~1asset-shares~1{id}~1access-token/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get an asset share access token","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":"Get an access token for viewing data which has been shared as part of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Asset-Shares"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetShare"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":".  Use this access token in the same way as the normal signed-in user token to make requests with the permissions of the share applied."},"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":"This endpoint is unauthenticated. Do not send a Bearer Token in the Authorization Header"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Asset-Shares"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetShare"},"children":[]}]}]}]}],"required":true}],"pointer":"/paths/~1asset-shares~1{id}~1access-token/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/asset-shares/{id}/access-token","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","4XX"],"pointer":"/asset-shares/{id}/access-token","href":"asset-share-access-tokens/getassetshareaccesstoken","openApiOperationId":"getAssetShareAccessToken","summary":"Get an asset share access token"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccessTokenWithPermittedActions"}},"schemaId":"components/schemas/AccessTokenWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1asset-shares~1{id}~1access-token/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AccessTokenWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccessTokenWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/asset-share-access-tokens/getassetshareaccesstoken"}],"panels":[]}]},"httpPath":"/asset-shares/{id}/access-token"}],"content":{"contentType":"group","meta":{"name":"Asset Share Access Tokens"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Asset Share Access Tokens","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/asset-shares/{id}/access-token","summary":"Get an asset share access token","prefix":{"name":"get","color":"get"},"badges":[],"link":"/asset-share-access-tokens/getassetshareaccesstoken","deprecated":false}]}]}]}]}},{"type":"group","label":"Asset Share Emails","link":"/dash/openapi/asset-share-emails","routeSlug":"/dash/openapi/asset-share-emails","items":[{"label":"Email a link to an asset share","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/asset-share-emails/createassetshareemail","routeSlug":"/dash/openapi/asset-share-emails/createassetshareemail","metadata":{"seo":{"title":"Email a link to an asset share","description":"Send an AssetShare via email to a specified email address"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createAssetShareEmail","name":"Email a link to an asset share","isWebhook":false,"pointer":"/paths/~1asset-share-emails/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Email a link to an asset share","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":"Send an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Asset-Shares"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetShare"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" via email to a specified email address"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AssetShareEmailRequest"}},"schemaId":"components/schemas/AssetShareEmailRequest","pointer":"/paths/~1asset-share-emails/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/asset-share-emails","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AssetShareEmailRequest"}},"responseCodes":["204","4XX"],"pointer":"/asset-share-emails","href":"asset-share-emails/createassetshareemail","openApiOperationId":"createAssetShareEmail","summary":"Email a link to an asset share"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/AssetShareEmailRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AssetShareEmailRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1asset-share-emails/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/asset-share-emails/createassetshareemail"}],"panels":[]}]},"httpPath":"/asset-share-emails"}],"content":{"contentType":"group","meta":{"name":"Asset Share Emails"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Asset Share Emails","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/asset-share-emails","summary":"Email a link to an asset share","prefix":{"name":"post","color":"post"},"badges":[],"link":"/asset-share-emails/createassetshareemail","deprecated":false}]}]}]}]}},{"type":"separator","label":"Collection","content":null},{"type":"group","label":"Collections","link":"/dash/openapi/collections","routeSlug":"/dash/openapi/collections","items":[{"label":"Create a collection","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/collections/postcollection","routeSlug":"/dash/openapi/collections/postcollection","metadata":{"seo":{"title":"Create a collection","description":"Create a new Collection."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postCollection","name":"Create a collection","isWebhook":false,"pointer":"/paths/~1collections/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a collection","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":"Create a new "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Collection"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Collection"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CollectionRequest"}},"schemaId":"components/schemas/CollectionRequest","pointer":"/paths/~1collections/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/collections","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CollectionRequest"}},"responseCodes":["200","4XX"],"pointer":"/collections","href":"collections/postcollection","openApiOperationId":"postCollection","summary":"Create a collection"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/CollectionRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CollectionRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CollectionWithPermittedActions"}},"schemaId":"components/schemas/CollectionWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1collections/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CollectionWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CollectionWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/collections/postcollection"}],"panels":[]}]},"httpPath":"/collections"},{"label":"Update a collection","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/collections/patchcollection","routeSlug":"/dash/openapi/collections/patchcollection","metadata":{"seo":{"title":"Update a collection","description":"Patch a Collection"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchCollection","name":"Update a collection","isWebhook":false,"pointer":"/paths/~1collections~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a collection","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":"Patch a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Collections"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Collection"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Collections"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Collection"},"children":[]}]}]}]}],"required":true}],"pointer":"/paths/~1collections~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CollectionPatchRequest"}},"schemaId":"components/schemas/CollectionPatchRequest","pointer":"/paths/~1collections~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/collections/{id}","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CollectionPatchRequest"}},"responseCodes":["200","4XX"],"pointer":"/collections/{id}","href":"collections/patchcollection","openApiOperationId":"patchCollection","summary":"Update a collection"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/CollectionPatchRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CollectionPatchRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CollectionWithPermittedActions"}},"schemaId":"components/schemas/CollectionWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1collections~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CollectionWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CollectionWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/collections/patchcollection"}],"panels":[]}]},"httpPath":"/collections/{id}"},{"label":"Search for collections","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/collections/postcollectionsearch","routeSlug":"/dash/openapi/collections/postcollectionsearch","metadata":{"seo":{"title":"Search for collections","description":"Create a new CollectionSearch"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postCollectionSearch","name":"Search for collections","isWebhook":false,"pointer":"/paths/~1collection-searches/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search for collections","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":"Create a new "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/collections/postcollectionsearch"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CollectionSearch"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The most commmon use of an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/collections/postcollectionsearch"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CollectionSearch"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is to retrieve all the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Collections"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Collection"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources associated with a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Users"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CollectionSearchRequest","exampleIds":["paths/~1collection-searches/post/requestBody/content/application~1json/examples/Search for collections associated with user"]}},"schemaId":"components/schemas/CollectionSearchRequest","exampleIds":["paths/~1collection-searches/post/requestBody/content/application~1json/examples/Search for collections associated with user"],"pointer":"/paths/~1collection-searches/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/collection-searches","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CollectionSearchRequest","exampleIds":["paths/~1collection-searches/post/requestBody/content/application~1json/examples/Search for collections associated with user"]}},"responseCodes":["200","4XX"],"pointer":"/collection-searches","href":"collections/postcollectionsearch","openApiOperationId":"postCollectionSearch","summary":"Search for collections"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/CollectionSearchRequest","exampleIds":["paths/~1collection-searches/post/requestBody/content/application~1json/examples/Search for collections associated with user"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CollectionSearchRequest","exampleIds":["paths/~1collection-searches/post/requestBody/content/application~1json/examples/Search for collections associated with user"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CollectionSearch","exampleIds":["paths/~1collection-searches/post/responses/200/content/application~1json/examples/Search for collections associated with user"]}},"schemaId":"components/schemas/CollectionSearch","exampleIds":["paths/~1collection-searches/post/responses/200/content/application~1json/examples/Search for collections associated with user"]},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1collection-searches/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CollectionSearch","exampleIds":["paths/~1collection-searches/post/responses/200/content/application~1json/examples/Search for collections associated with user"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CollectionSearch","exampleIds":["paths/~1collection-searches/post/responses/200/content/application~1json/examples/Search for collections associated with user"]}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/collections/postcollectionsearch"}],"panels":[]}]},"httpPath":"/collection-searches"}],"content":{"contentType":"group","meta":{"name":"Collections"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Collections","showPageActions":true},{"nodeType":"markdoc","content":[{"$$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":"link","inline":true,"attributes":{"href":"/dash/openapi/Collections"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Collection"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a user defined set of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources."},"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":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources in a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Collections"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Collection"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are not returned with the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Collections"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Collection"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To get the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources you must create an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/postassetsearch"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Asset Search"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Collections"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Collection.id"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as the value in a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COLLECTIONS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" : "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FIELD_EQUALS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" criterion."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Searching allows you to find "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Collections"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Collection"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources in your Dash matching specific criteria."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A list of sorts can also be provided to control the order in the which the results are returned."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/collections","summary":"Create a collection","prefix":{"name":"post","color":"post"},"badges":[],"link":"/collections/postcollection","deprecated":false},{"title":"/collections/{id}","summary":"Update a collection","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/collections/patchcollection","deprecated":false},{"title":"/collection-searches","summary":"Search for collections","prefix":{"name":"post","color":"post"},"badges":[],"link":"/collections/postcollectionsearch","deprecated":false}]}]}]}]}},{"type":"group","label":"Collection Shares","link":"/dash/openapi/collection-shares","routeSlug":"/dash/openapi/collection-shares","items":[{"label":"Create a collection share","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/collection-shares/postcollectionshare","routeSlug":"/dash/openapi/collection-shares/postcollectionshare","metadata":{"seo":{"title":"Create a collection share","description":"Create a new CollectionShare, making a Collection available to anyone who has one of the CollectionShare.slugs."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postCollectionShare","name":"Create a collection share","isWebhook":false,"pointer":"/paths/~1collection-shares/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a collection share","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":"Create a new "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Collection-Share"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CollectionShare"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", making a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Collection"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Collection"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" available to anyone who has one of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CollectionShare.slugs"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CollectionShareRequest"}},"schemaId":"components/schemas/CollectionShareRequest","pointer":"/paths/~1collection-shares/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/collection-shares","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CollectionShareRequest"}},"responseCodes":["200","4XX"],"pointer":"/collection-shares","href":"collection-shares/postcollectionshare","openApiOperationId":"postCollectionShare","summary":"Create a collection share"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/CollectionShareRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CollectionShareRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CollectionShareWithPermittedActions"}},"schemaId":"components/schemas/CollectionShareWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1collection-shares/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CollectionShareWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CollectionShareWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/collection-shares/postcollectionshare"}],"panels":[]}]},"httpPath":"/collection-shares"},{"label":"Get a collection share","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/collection-shares/getcollectionshare","routeSlug":"/dash/openapi/collection-shares/getcollectionshare","metadata":{"seo":{"title":"Get a collection share","description":"Get a CollectionShare"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCollectionShare","name":"Get a collection share","isWebhook":false,"pointer":"/paths/~1collection-shares~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a collection share","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":"Get a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Collection-Shares"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CollectionShare"},"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":"This endpoint is unauthenticated. Do not send a Bearer Token in the Authorization Header"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Collection-Shares"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CollectionShare"},"children":[]}]}]}]}],"required":true}],"pointer":"/paths/~1collection-shares~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/collection-shares/{id}","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","4XX"],"pointer":"/collection-shares/{id}","href":"collection-shares/getcollectionshare","openApiOperationId":"getCollectionShare","summary":"Get a collection share"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CollectionShareWithPermittedActions"}},"schemaId":"components/schemas/CollectionShareWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1collection-shares~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CollectionShareWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CollectionShareWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/collection-shares/getcollectionshare"}],"panels":[]}]},"httpPath":"/collection-shares/{id}"},{"label":"Update a collection share","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/collection-shares/patchcollectionshare","routeSlug":"/dash/openapi/collection-shares/patchcollectionshare","metadata":{"seo":{"title":"Update a collection share","description":"Patch a CollectionShare"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchCollectionShare","name":"Update a collection share","isWebhook":false,"pointer":"/paths/~1collection-shares~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a collection share","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":"Patch a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Collection-Shares"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CollectionShare"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Collection-Shares"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CollectionShare"},"children":[]}]}]}]}],"required":true}],"pointer":"/paths/~1collection-shares~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AssetSharePatchRequest"}},"schemaId":"components/schemas/AssetSharePatchRequest","pointer":"/paths/~1collection-shares~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/collection-shares/{id}","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AssetSharePatchRequest"}},"responseCodes":["200","4XX"],"pointer":"/collection-shares/{id}","href":"collection-shares/patchcollectionshare","openApiOperationId":"patchCollectionShare","summary":"Update a collection share"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/AssetSharePatchRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AssetSharePatchRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CollectionShareWithPermittedActions"}},"schemaId":"components/schemas/CollectionShareWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1collection-shares~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CollectionShareWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CollectionShareWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/collection-shares/patchcollectionshare"}],"panels":[]}]},"httpPath":"/collection-shares/{id}"},{"label":"Delete a collection share","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/collection-shares/deletecollectionshare","routeSlug":"/dash/openapi/collection-shares/deletecollectionshare","metadata":{"seo":{"title":"Delete a collection share","description":"Delete a CollectionShare"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteCollectionShare","name":"Delete a collection share","isWebhook":false,"pointer":"/paths/~1collection-shares~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a collection share","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":"Delete a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Collection-Shares"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CollectionShare"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Collection-Shares"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CollectionShare"},"children":[]}]}]}]}],"required":true}],"pointer":"/paths/~1collection-shares~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/collection-shares/{id}","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","4XX"],"pointer":"/collection-shares/{id}","href":"collection-shares/deletecollectionshare","openApiOperationId":"deleteCollectionShare","summary":"Delete a collection share"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1collection-shares~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/collection-shares/deletecollectionshare"}],"panels":[]}]},"httpPath":"/collection-shares/{id}"},{"label":"Search for collection shares","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/collection-shares/postcollectionsharesearch","routeSlug":"/dash/openapi/collection-shares/postcollectionsharesearch","metadata":{"seo":{"title":"Search for collection shares","description":"Create a new CollectionShareSearch"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postCollectionShareSearch","name":"Search for collection shares","isWebhook":false,"pointer":"/paths/~1collection-share-searches/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search for collection shares","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":"Create a new "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/collections/postcollectionsearch"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CollectionShareSearch"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CollectionShareSearchRequest"}},"schemaId":"components/schemas/CollectionShareSearchRequest","pointer":"/paths/~1collection-share-searches/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/collection-share-searches","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CollectionShareSearchRequest"}},"responseCodes":["200","4XX"],"pointer":"/collection-share-searches","href":"collection-shares/postcollectionsharesearch","openApiOperationId":"postCollectionShareSearch","summary":"Search for collection shares"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/CollectionShareSearchRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CollectionShareSearchRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CollectionShareSearch"}},"schemaId":"components/schemas/CollectionShareSearch"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1collection-share-searches/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CollectionShareSearch","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CollectionShareSearch"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/collection-shares/postcollectionsharesearch"}],"panels":[]}]},"httpPath":"/collection-share-searches"},{"label":"Search for publicly available collection shares","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/collection-shares/postpubliclyavailablecollectionsharesearch","routeSlug":"/dash/openapi/collection-shares/postpubliclyavailablecollectionsharesearch","metadata":{"seo":{"title":"Search for publicly available collection shares","description":"Create a new CollectionShareSearch"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postPubliclyAvailableCollectionShareSearch","name":"Search for publicly available collection shares","isWebhook":false,"pointer":"/paths/~1publicly-available-collection-share-searches/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search for publicly available collection shares","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":"Create a new "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/collections/postcollectionsearch"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CollectionShareSearch"},"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":"This endpoint is unauthenticated. Do not send a Bearer Token in the Authorization Header"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PublicCollectionShareSearchRequest"}},"schemaId":"components/schemas/PublicCollectionShareSearchRequest","pointer":"/paths/~1publicly-available-collection-share-searches/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/publicly-available-collection-share-searches","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/PublicCollectionShareSearchRequest"}},"responseCodes":["200","4XX"],"pointer":"/publicly-available-collection-share-searches","href":"collection-shares/postpubliclyavailablecollectionsharesearch","openApiOperationId":"postPubliclyAvailableCollectionShareSearch","summary":"Search for publicly available collection shares"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/PublicCollectionShareSearchRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PublicCollectionShareSearchRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CollectionShareSearch"}},"schemaId":"components/schemas/CollectionShareSearch"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1publicly-available-collection-share-searches/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CollectionShareSearch","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CollectionShareSearch"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/collection-shares/postpubliclyavailablecollectionsharesearch"}],"panels":[]}]},"httpPath":"/publicly-available-collection-share-searches"}],"content":{"contentType":"group","meta":{"name":"Collection Shares"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Collection Shares","showPageActions":true},{"nodeType":"markdoc","content":[{"$$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":"link","inline":true,"attributes":{"href":"/dash/openapi/Collection-Shares"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CollectionShare"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Collection"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Collection"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that has been made accessible to anyone with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"slug"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Collection"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Collection"},"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":"Searching allows you to find "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Collection-Shares"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CollectionShare"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources in your Dash matching specific criteria."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A list of sorts can also be provided to control the order in the which the results are returned."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/collection-shares","summary":"Create a collection share","prefix":{"name":"post","color":"post"},"badges":[],"link":"/collection-shares/postcollectionshare","deprecated":false},{"title":"/collection-shares/{id}","summary":"Get a collection share","prefix":{"name":"get","color":"get"},"badges":[],"link":"/collection-shares/getcollectionshare","deprecated":false},{"title":"/collection-shares/{id}","summary":"Update a collection share","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/collection-shares/patchcollectionshare","deprecated":false},{"title":"/collection-shares/{id}","summary":"Delete a collection share","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/collection-shares/deletecollectionshare","deprecated":false},{"title":"/collection-share-searches","summary":"Search for collection shares","prefix":{"name":"post","color":"post"},"badges":[],"link":"/collection-shares/postcollectionsharesearch","deprecated":false},{"title":"/publicly-available-collection-share-searches","summary":"Search for publicly available collection shares","prefix":{"name":"post","color":"post"},"badges":[],"link":"/collection-shares/postpubliclyavailablecollectionsharesearch","deprecated":false}]}]}]}]}},{"type":"separator","label":"Cloud Import","content":null},{"type":"group","label":"Cloud Connections","link":"/dash/openapi/cloud-connections","routeSlug":"/dash/openapi/cloud-connections","items":[{"label":"Create a cloud connection","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/cloud-connections/postcloudconnections","routeSlug":"/dash/openapi/cloud-connections/postcloudconnections","metadata":{"seo":{"title":"Create a cloud connection","description":"Create a new Cloud Connections resource to connect to a cloud storage providers and import assets into Dash"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postCloudConnections","name":"Create a cloud connection","isWebhook":false,"pointer":"/paths/~1cloud-connections/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a cloud connection","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":"Create a new "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Cloud-Connections"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Cloud Connections"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource to connect to a cloud storage providers and import assets into Dash"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CloudConnectionRequest"}},"schemaId":"components/schemas/CloudConnectionRequest","pointer":"/paths/~1cloud-connections/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/cloud-connections","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CloudConnectionRequest"}},"responseCodes":["200","4XX"],"pointer":"/cloud-connections","href":"cloud-connections/postcloudconnections","openApiOperationId":"postCloudConnections","summary":"Create a cloud connection"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/CloudConnectionRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CloudConnectionRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CloudConnectionWithPermittedActions"}},"schemaId":"components/schemas/CloudConnectionWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1cloud-connections/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CloudConnectionWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CloudConnectionWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cloud-connections/postcloudconnections"}],"panels":[]}]},"httpPath":"/cloud-connections"},{"label":"Get a cloud connection","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/cloud-connections/getcloudconnection","routeSlug":"/dash/openapi/cloud-connections/getcloudconnection","metadata":{"seo":{"title":"Get a cloud connection","description":"Get a CloudConnection resource to connect which connects to Cloud Storage Providers in order to import assets into Dash"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCloudConnection","name":"Get a cloud connection","isWebhook":false,"pointer":"/paths/~1cloud-connections~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a cloud connection","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":"Get a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Cloud-Connections"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CloudConnection"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource to connect which connects to Cloud Storage Providers in order to import assets into Dash"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Cloud-Connections"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CloudConnection"},"children":[]}]}]}]}],"required":true}],"pointer":"/paths/~1cloud-connections~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/cloud-connections/{id}","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","4XX"],"pointer":"/cloud-connections/{id}","href":"cloud-connections/getcloudconnection","openApiOperationId":"getCloudConnection","summary":"Get a cloud connection"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CloudConnectionWithPermittedActions"}},"schemaId":"components/schemas/CloudConnectionWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1cloud-connections~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CloudConnectionWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CloudConnectionWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cloud-connections/getcloudconnection"}],"panels":[]}]},"httpPath":"/cloud-connections/{id}"},{"label":"Delete a cloud connection","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/cloud-connections/deletecloudconnection","routeSlug":"/dash/openapi/cloud-connections/deletecloudconnection","metadata":{"seo":{"title":"Delete a cloud connection","description":"Delete a Cloud Connections resource"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteCloudConnection","name":"Delete a cloud connection","isWebhook":false,"pointer":"/paths/~1cloud-connections~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a cloud connection","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":"Delete a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Cloud-Connections"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Cloud Connections"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Cloud-Connections"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Cloud Connections"},"children":[]}]}]}]}],"required":true}],"pointer":"/paths/~1cloud-connections~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/cloud-connections/{id}","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","4XX"],"pointer":"/cloud-connections/{id}","href":"cloud-connections/deletecloudconnection","openApiOperationId":"deleteCloudConnection","summary":"Delete a cloud connection"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1cloud-connections~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cloud-connections/deletecloudconnection"}],"panels":[]}]},"httpPath":"/cloud-connections/{id}"},{"label":"Get the current user's cloud connections","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/cloud-connections/getcurrentusercloudconnections","routeSlug":"/dash/openapi/cloud-connections/getcurrentusercloudconnections","metadata":{"seo":{"title":"Get the current user's cloud connections","description":"Get all the CloudConnection resources for the current user"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCurrentUserCloudConnections","name":"Get the current user's cloud connections","isWebhook":false,"pointer":"/paths/~1current-user-cloud-connections/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get the current user's cloud connections","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":"Get all the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Cloud-Connections"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CloudConnection"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources for the current user"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/current-user-cloud-connections","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","4XX"],"pointer":"/current-user-cloud-connections","href":"cloud-connections/getcurrentusercloudconnections","openApiOperationId":"getCurrentUserCloudConnections","summary":"Get the current user's cloud connections"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_30"}},"schemaId":"schema_30"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1current-user-cloud-connections/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_30","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_30"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cloud-connections/getcurrentusercloudconnections"}],"panels":[]}]},"httpPath":"/current-user-cloud-connections"},{"label":"Proxy for OAuth callback","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/cloud-connections/getoauthcallback","routeSlug":"/dash/openapi/cloud-connections/getoauthcallback","metadata":{"seo":{"title":"Proxy for OAuth callback","description":"This endpoint is unauthenticated. Do not send a Bearer Token in the Authorization Header"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getOAuthCallback","name":"Proxy for OAuth callback","isWebhook":false,"pointer":"/paths/~1oauth-callback/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Proxy for OAuth callback","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"blockquote","attributes":{},"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":"This endpoint is unauthenticated. Do not send a Bearer Token in the Authorization Header"},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/oauth-callback","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["302","4XX"],"pointer":"/oauth-callback","href":"cloud-connections/getoauthcallback","openApiOperationId":"getOAuthCallback","summary":"Proxy for OAuth callback"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"302","description":"Success"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1oauth-callback/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"302"},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cloud-connections/getoauthcallback"}],"panels":[]}]},"httpPath":"/oauth-callback"}],"content":{"contentType":"group","meta":{"name":"Cloud Connections"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cloud Connections","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Coming soon; "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"mailto:help@dash.app"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contact us"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if you need access to this API endpoint."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/cloud-connections","summary":"Create a cloud connection","prefix":{"name":"post","color":"post"},"badges":[],"link":"/cloud-connections/postcloudconnections","deprecated":false},{"title":"/cloud-connections/{id}","summary":"Get a cloud connection","prefix":{"name":"get","color":"get"},"badges":[],"link":"/cloud-connections/getcloudconnection","deprecated":false},{"title":"/cloud-connections/{id}","summary":"Delete a cloud connection","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/cloud-connections/deletecloudconnection","deprecated":false},{"title":"/current-user-cloud-connections","summary":"Get the current user's cloud connections","prefix":{"name":"get","color":"get"},"badges":[],"link":"/cloud-connections/getcurrentusercloudconnections","deprecated":false},{"title":"/oauth-callback","summary":"Proxy for OAuth callback","prefix":{"name":"get","color":"get"},"badges":[],"link":"/cloud-connections/getoauthcallback","deprecated":false}]}]}]}]}},{"type":"group","label":"Cloud Import Jobs","link":"/dash/openapi/cloud-import-jobs","routeSlug":"/dash/openapi/cloud-import-jobs","items":[{"label":"Import cloud objects","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/cloud-import-jobs/postcloudimportjobs","routeSlug":"/dash/openapi/cloud-import-jobs/postcloudimportjobs","metadata":{"seo":{"title":"Import cloud objects","description":"Create a new Cloud Import Job resource to import assets into Dash"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postCloudImportJobs","name":"Import cloud objects","isWebhook":false,"pointer":"/paths/~1cloud-import-jobs/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Import cloud objects","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":"Create a new "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Cloud-Import-Jobs"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Cloud Import Job"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource to import assets into Dash"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CloudImportJobRequest"}},"schemaId":"components/schemas/CloudImportJobRequest","pointer":"/paths/~1cloud-import-jobs/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/cloud-import-jobs","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CloudImportJobRequest"}},"responseCodes":["200","4XX"],"pointer":"/cloud-import-jobs","href":"cloud-import-jobs/postcloudimportjobs","openApiOperationId":"postCloudImportJobs","summary":"Import cloud objects"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/CloudImportJobRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CloudImportJobRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CloudImportJobWithPermittedActions"}},"schemaId":"components/schemas/CloudImportJobWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1cloud-import-jobs/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CloudImportJobWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CloudImportJobWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cloud-import-jobs/postcloudimportjobs"}],"panels":[]}]},"httpPath":"/cloud-import-jobs"},{"label":"Get the status of a cloud object import","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/cloud-import-jobs/getcloudimportjob","routeSlug":"/dash/openapi/cloud-import-jobs/getcloudimportjob","metadata":{"seo":{"title":"Get the status of a cloud object import","description":"Get the status and eventual result of a CloudImportJob"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCloudImportJob","name":"Get the status of a cloud object import","isWebhook":false,"pointer":"/paths/~1cloud-import-jobs~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get the status of a cloud object import","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":"Get the status and eventual result of a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/cloud-import-jobs/postcloudimportjobs"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CloudImportJob"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/cloud-import-jobs/postcloudimportjobs"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CloudImportJob"},"children":[]}]}]}]}],"required":true}],"pointer":"/paths/~1cloud-import-jobs~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/cloud-import-jobs/{id}","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","4XX"],"pointer":"/cloud-import-jobs/{id}","href":"cloud-import-jobs/getcloudimportjob","openApiOperationId":"getCloudImportJob","summary":"Get the status of a cloud object import"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CloudImportJobWithPermittedActions"}},"schemaId":"components/schemas/CloudImportJobWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1cloud-import-jobs~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CloudImportJobWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CloudImportJobWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cloud-import-jobs/getcloudimportjob"}],"panels":[]}]},"httpPath":"/cloud-import-jobs/{id}"},{"label":"Update the status of a cloud object import","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/cloud-import-jobs/patchcloudimportjob","routeSlug":"/dash/openapi/cloud-import-jobs/patchcloudimportjob","metadata":{"seo":{"title":"Update the status of a cloud object import","description":"Update a CloudImportJob. Primarily used to stop a job."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchCloudImportJob","name":"Update the status of a cloud object import","isWebhook":false,"pointer":"/paths/~1cloud-import-jobs~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update the status of a cloud object import","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":"Update a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/cloud-import-jobs/postcloudimportjobs"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CloudImportJob"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Primarily used to stop a job."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/cloud-import-jobs/postcloudimportjobs"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CloudImportJob"},"children":[]}]}]}]}],"required":true}],"pointer":"/paths/~1cloud-import-jobs~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/JobPatchRequest"}},"schemaId":"components/schemas/JobPatchRequest","pointer":"/paths/~1cloud-import-jobs~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/cloud-import-jobs/{id}","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/JobPatchRequest"}},"responseCodes":["200","4XX"],"pointer":"/cloud-import-jobs/{id}","href":"cloud-import-jobs/patchcloudimportjob","openApiOperationId":"patchCloudImportJob","summary":"Update the status of a cloud object import"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/JobPatchRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/JobPatchRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CloudImportJobWithPermittedActions"}},"schemaId":"components/schemas/CloudImportJobWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1cloud-import-jobs~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CloudImportJobWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CloudImportJobWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cloud-import-jobs/patchcloudimportjob"}],"panels":[]}]},"httpPath":"/cloud-import-jobs/{id}"},{"label":"Delete a cloud object import","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/cloud-import-jobs/deletecloudimportjob","routeSlug":"/dash/openapi/cloud-import-jobs/deletecloudimportjob","metadata":{"seo":{"title":"Delete a cloud object import","description":"Deletes a CloudImportJob"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteCloudImportJob","name":"Delete a cloud object import","isWebhook":false,"pointer":"/paths/~1cloud-import-jobs~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a cloud object import","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 "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/cloud-import-jobs/postcloudimportjobs"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CloudImportJob"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/cloud-import-jobs/postcloudimportjobs"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CloudImportJob"},"children":[]}]}]}]}],"required":true}],"pointer":"/paths/~1cloud-import-jobs~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/cloud-import-jobs/{id}","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","4XX"],"pointer":"/cloud-import-jobs/{id}","href":"cloud-import-jobs/deletecloudimportjob","openApiOperationId":"deleteCloudImportJob","summary":"Delete a cloud object import"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1cloud-import-jobs~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cloud-import-jobs/deletecloudimportjob"}],"panels":[]}]},"httpPath":"/cloud-import-jobs/{id}"},{"label":"Get the current user's cloud imports","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/cloud-import-jobs/getcurrentusercloudimportjobs","routeSlug":"/dash/openapi/cloud-import-jobs/getcurrentusercloudimportjobs","metadata":{"seo":{"title":"Get the current user's cloud imports","description":"Get all CloudImportJob resources for the current user"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCurrentUserCloudImportJobs","name":"Get the current user's cloud imports","isWebhook":false,"pointer":"/paths/~1current-user-cloud-import-jobs/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get the current user's cloud imports","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":"Get all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Cloud-Import-Jobs"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CloudImportJob"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources for the current user"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"type","in":"query","schemaId":"schema_31","description":"The cloud provider type of the jobs to get"}],"pointer":"/paths/~1current-user-cloud-import-jobs/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/current-user-cloud-import-jobs","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[{"name":"type","in":"query","schemaId":"schema_31"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","4XX"],"pointer":"/current-user-cloud-import-jobs","href":"cloud-import-jobs/getcurrentusercloudimportjobs","openApiOperationId":"getCurrentUserCloudImportJobs","summary":"Get the current user's cloud imports"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_32"}},"schemaId":"schema_32"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1current-user-cloud-import-jobs/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_32","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_32"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cloud-import-jobs/getcurrentusercloudimportjobs"}],"panels":[]}]},"httpPath":"/current-user-cloud-import-jobs"}],"content":{"contentType":"group","meta":{"name":"Cloud Import Jobs"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cloud Import Jobs","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Coming soon; "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"mailto:help@dash.app"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contact us"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if you need access to this API endpoint."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/cloud-import-jobs","summary":"Import cloud objects","prefix":{"name":"post","color":"post"},"badges":[],"link":"/cloud-import-jobs/postcloudimportjobs","deprecated":false},{"title":"/cloud-import-jobs/{id}","summary":"Get the status of a cloud object import","prefix":{"name":"get","color":"get"},"badges":[],"link":"/cloud-import-jobs/getcloudimportjob","deprecated":false},{"title":"/cloud-import-jobs/{id}","summary":"Update the status of a cloud object import","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/cloud-import-jobs/patchcloudimportjob","deprecated":false},{"title":"/cloud-import-jobs/{id}","summary":"Delete a cloud object import","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/cloud-import-jobs/deletecloudimportjob","deprecated":false},{"title":"/current-user-cloud-import-jobs","summary":"Get the current user's cloud imports","prefix":{"name":"get","color":"get"},"badges":[],"link":"/cloud-import-jobs/getcurrentusercloudimportjobs","deprecated":false}]}]}]}]}},{"type":"group","label":"Cloud Objects","link":"/dash/openapi/cloud-objects","routeSlug":"/dash/openapi/cloud-objects","items":[{"label":"Get a cloud object","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/cloud-objects/getcloudobject","routeSlug":"/dash/openapi/cloud-objects/getcloudobject","metadata":{"seo":{"title":"Get a cloud object","description":"Get a CloudObject"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCloudObject","name":"Get a cloud object","isWebhook":false,"pointer":"/paths/~1cloud-connections~1{id}~1cloud-objects~1{cloudObjectId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a cloud object","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a CloudObject\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_25","description":"The unique ID of the CloudConnection that the CloudObject belongs to","required":true},{"name":"cloudObjectId","in":"path","schemaId":"schema_25","description":"The unique ID of the CloudObject","required":true}],"pointer":"/paths/~1cloud-connections~1{id}~1cloud-objects~1{cloudObjectId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/cloud-connections/{id}/cloud-objects/{cloudObjectId}","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_25"},{"name":"cloudObjectId","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","4XX"],"pointer":"/cloud-connections/{id}/cloud-objects/{cloudObjectId}","href":"cloud-objects/getcloudobject","openApiOperationId":"getCloudObject","summary":"Get a cloud object"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CloudObject"}},"schemaId":"components/schemas/CloudObject"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1cloud-connections~1{id}~1cloud-objects~1{cloudObjectId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CloudObject","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CloudObject"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cloud-objects/getcloudobject"}],"panels":[]}]},"httpPath":"/cloud-connections/{id}/cloud-objects/{cloudObjectId}"},{"label":"Search for cloud objects","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/cloud-objects/postcloudobjectsearches","routeSlug":"/dash/openapi/cloud-objects/postcloudobjectsearches","metadata":{"seo":{"title":"Search for cloud objects","description":"Search for cloud objects"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postCloudObjectSearches","name":"Search for cloud objects","isWebhook":false,"pointer":"/paths/~1cloud-object-searches/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search for cloud objects","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CloudObjectPagedSearchRequest"}},"schemaId":"components/schemas/CloudObjectPagedSearchRequest","pointer":"/paths/~1cloud-object-searches/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/cloud-object-searches","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CloudObjectPagedSearchRequest"}},"responseCodes":["200","4XX"],"pointer":"/cloud-object-searches","href":"cloud-objects/postcloudobjectsearches","openApiOperationId":"postCloudObjectSearches","summary":"Search for cloud objects"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/CloudObjectPagedSearchRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CloudObjectPagedSearchRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CloudObjectPagedSearch"}},"schemaId":"components/schemas/CloudObjectPagedSearch"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1cloud-object-searches/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CloudObjectPagedSearch","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CloudObjectPagedSearch"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cloud-objects/postcloudobjectsearches"}],"panels":[]}]},"httpPath":"/cloud-object-searches"}],"content":{"contentType":"group","meta":{"name":"Cloud Objects"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cloud Objects","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Coming soon; "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"mailto:help@dash.app"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contact us"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if you need access to this API endpoint."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/cloud-connections/{id}/cloud-objects/{cloudObjectId}","summary":"Get a cloud object","prefix":{"name":"get","color":"get"},"badges":[],"link":"/cloud-objects/getcloudobject","deprecated":false},{"title":"/cloud-object-searches","summary":"Search for cloud objects","prefix":{"name":"post","color":"post"},"badges":[],"link":"/cloud-objects/postcloudobjectsearches","deprecated":false}]}]}]}]}},{"type":"separator","label":"Domain","content":null},{"type":"group","label":"Subdomains","link":"/dash/openapi/subdomains","routeSlug":"/dash/openapi/subdomains","items":[{"label":"Check subdomain availability","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/subdomains/postsubdomainavailabilitycheck","routeSlug":"/dash/openapi/subdomains/postsubdomainavailabilitycheck","metadata":{"seo":{"title":"Check subdomain availability","description":"This endpoint is unauthenticated. Do not send a Bearer Token in the Authorization Header"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postSubdomainAvailabilityCheck","name":"Check subdomain availability","isWebhook":false,"pointer":"/paths/~1subdomain-availability-check/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Check subdomain availability","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"blockquote","attributes":{},"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":"This endpoint is unauthenticated. Do not send a Bearer Token in the Authorization Header"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SubdomainAvailabilityCheckRequest"}},"schemaId":"components/schemas/SubdomainAvailabilityCheckRequest","pointer":"/paths/~1subdomain-availability-check/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/subdomain-availability-check","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/SubdomainAvailabilityCheckRequest"}},"responseCodes":["200","4XX"],"pointer":"/subdomain-availability-check","href":"subdomains/postsubdomainavailabilitycheck","openApiOperationId":"postSubdomainAvailabilityCheck","summary":"Check subdomain availability"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/SubdomainAvailabilityCheckRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SubdomainAvailabilityCheckRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubdomainAvailabilityCheck"}},"schemaId":"components/schemas/SubdomainAvailabilityCheck"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1subdomain-availability-check/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SubdomainAvailabilityCheck","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubdomainAvailabilityCheck"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subdomains/postsubdomainavailabilitycheck"}],"panels":[]}]},"httpPath":"/subdomain-availability-check"}],"content":{"contentType":"group","meta":{"name":"Subdomains"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Subdomains","showPageActions":true},{"nodeType":"markdoc","content":[{"$$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":"link","inline":true,"attributes":{"href":"/dash/openapi/subdomains/postsubdomainavailabilitycheck"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SubdomainAvailabilityCheck"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used to check whether a Dash subdomain is in use or not."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/subdomain-availability-check","summary":"Check subdomain availability","prefix":{"name":"post","color":"post"},"badges":[],"link":"/subdomains/postsubdomainavailabilitycheck","deprecated":false}]}]}]}]}},{"type":"group","label":"Ping","link":"/dash/openapi/ping","routeSlug":"/dash/openapi/ping","items":[{"label":"Check Dash API availability","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/ping/getping","routeSlug":"/dash/openapi/ping/getping","metadata":{"seo":{"title":"Check Dash API availability","description":"This endpoint is unauthenticated. Do not send a Bearer Token in the Authorization Header"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPing","name":"Check Dash API availability","isWebhook":false,"pointer":"/paths/~1dash-ping/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Check Dash API availability","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"blockquote","attributes":{},"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":"This endpoint is unauthenticated. Do not send a Bearer Token in the Authorization Header"},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/dash-ping","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","4XX"],"pointer":"/dash-ping","href":"ping/getping","openApiOperationId":"getPing","summary":"Check Dash API availability"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_33"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1dash-ping/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ping/getping"}],"panels":[]}]},"httpPath":"/dash-ping"}],"content":{"contentType":"group","meta":{"name":"Ping"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Ping","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/dash-ping","summary":"Check Dash API availability","prefix":{"name":"get","color":"get"},"badges":[],"link":"/ping/getping","deprecated":false}]}]}]}]}},{"type":"separator","label":"Event","content":null},{"type":"group","label":"Asset Download Events","link":"/dash/openapi/asset-download-events","routeSlug":"/dash/openapi/asset-download-events","items":[{"label":"Search for asset download events","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/asset-download-events/postassetdownloadeventsearch","routeSlug":"/dash/openapi/asset-download-events/postassetdownloadeventsearch","metadata":{"seo":{"title":"Search for asset download events","description":"Create a new Asset Download Event Search"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postAssetDownloadEventSearch","name":"Search for asset download events","isWebhook":false,"pointer":"/paths/~1asset-download-event-searches/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search for asset download events","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":"Create a new "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/asset-download-events/postassetdownloadeventsearch"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset Download Event Search"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AssetDownloadEventSearchRequest","exampleIds":["paths/~1asset-download-event-searches/post/requestBody/content/application~1json/examples/Search downloads by user id","paths/~1asset-download-event-searches/post/requestBody/content/application~1json/examples/Search downloads by user email and asset id","paths/~1asset-download-event-searches/post/requestBody/content/application~1json/examples/Search downloads by multiple asset ids","paths/~1asset-download-event-searches/post/requestBody/content/application~1json/examples/Search downloads within date range","paths/~1asset-download-event-searches/post/requestBody/content/application~1json/examples/Aggregate all downloads by date","paths/~1asset-download-event-searches/post/requestBody/content/application~1json/examples/Aggregate portal downloads by portal","paths/~1asset-download-event-searches/post/requestBody/content/application~1json/examples/Aggregate account user downloads by user id","paths/~1asset-download-event-searches/post/requestBody/content/application~1json/examples/Aggregate account user downloads by user id and asset id"]}},"schemaId":"components/schemas/AssetDownloadEventSearchRequest","exampleIds":["paths/~1asset-download-event-searches/post/requestBody/content/application~1json/examples/Search downloads by user id","paths/~1asset-download-event-searches/post/requestBody/content/application~1json/examples/Search downloads by user email and asset id","paths/~1asset-download-event-searches/post/requestBody/content/application~1json/examples/Search downloads by multiple asset ids","paths/~1asset-download-event-searches/post/requestBody/content/application~1json/examples/Search downloads within date range","paths/~1asset-download-event-searches/post/requestBody/content/application~1json/examples/Aggregate all downloads by date","paths/~1asset-download-event-searches/post/requestBody/content/application~1json/examples/Aggregate portal downloads by portal","paths/~1asset-download-event-searches/post/requestBody/content/application~1json/examples/Aggregate account user downloads by user id","paths/~1asset-download-event-searches/post/requestBody/content/application~1json/examples/Aggregate account user downloads by user id and asset id"],"pointer":"/paths/~1asset-download-event-searches/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/asset-download-event-searches","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AssetDownloadEventSearchRequest","exampleIds":["paths/~1asset-download-event-searches/post/requestBody/content/application~1json/examples/Search downloads by user id","paths/~1asset-download-event-searches/post/requestBody/content/application~1json/examples/Search downloads by user email and asset id","paths/~1asset-download-event-searches/post/requestBody/content/application~1json/examples/Search downloads by multiple asset ids","paths/~1asset-download-event-searches/post/requestBody/content/application~1json/examples/Search downloads within date range","paths/~1asset-download-event-searches/post/requestBody/content/application~1json/examples/Aggregate all downloads by date","paths/~1asset-download-event-searches/post/requestBody/content/application~1json/examples/Aggregate portal downloads by portal","paths/~1asset-download-event-searches/post/requestBody/content/application~1json/examples/Aggregate account user downloads by user id","paths/~1asset-download-event-searches/post/requestBody/content/application~1json/examples/Aggregate account user downloads by user id and asset id"]}},"responseCodes":["200","4XX"],"pointer":"/asset-download-event-searches","href":"asset-download-events/postassetdownloadeventsearch","openApiOperationId":"postAssetDownloadEventSearch","summary":"Search for asset download events"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/AssetDownloadEventSearchRequest","exampleIds":["paths/~1asset-download-event-searches/post/requestBody/content/application~1json/examples/Search downloads by user id","paths/~1asset-download-event-searches/post/requestBody/content/application~1json/examples/Search downloads by user email and asset id","paths/~1asset-download-event-searches/post/requestBody/content/application~1json/examples/Search downloads by multiple asset ids","paths/~1asset-download-event-searches/post/requestBody/content/application~1json/examples/Search downloads within date range","paths/~1asset-download-event-searches/post/requestBody/content/application~1json/examples/Aggregate all downloads by date","paths/~1asset-download-event-searches/post/requestBody/content/application~1json/examples/Aggregate portal downloads by portal","paths/~1asset-download-event-searches/post/requestBody/content/application~1json/examples/Aggregate account user downloads by user id","paths/~1asset-download-event-searches/post/requestBody/content/application~1json/examples/Aggregate account user downloads by user id and asset id"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AssetDownloadEventSearchRequest","exampleIds":["paths/~1asset-download-event-searches/post/requestBody/content/application~1json/examples/Search downloads by user id","paths/~1asset-download-event-searches/post/requestBody/content/application~1json/examples/Search downloads by user email and asset id","paths/~1asset-download-event-searches/post/requestBody/content/application~1json/examples/Search downloads by multiple asset ids","paths/~1asset-download-event-searches/post/requestBody/content/application~1json/examples/Search downloads within date range","paths/~1asset-download-event-searches/post/requestBody/content/application~1json/examples/Aggregate all downloads by date","paths/~1asset-download-event-searches/post/requestBody/content/application~1json/examples/Aggregate portal downloads by portal","paths/~1asset-download-event-searches/post/requestBody/content/application~1json/examples/Aggregate account user downloads by user id","paths/~1asset-download-event-searches/post/requestBody/content/application~1json/examples/Aggregate account user downloads by user id and asset id"]}},"examples":[{},{},{},{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AssetDownloadEventSearch","exampleIds":["paths/~1asset-download-event-searches/post/responses/200/content/application~1json/examples/Results with paged events without aggregations","paths/~1asset-download-event-searches/post/responses/200/content/application~1json/examples/Results with paged events with aggregations","paths/~1asset-download-event-searches/post/responses/200/content/application~1json/examples/Results without paged events with terms bucket aggregations","paths/~1asset-download-event-searches/post/responses/200/content/application~1json/examples/Results without paged events with multiple terms bucket aggregations","paths/~1asset-download-event-searches/post/responses/200/content/application~1json/examples/Results without paged events with date histogram bucket aggregations","paths/~1asset-download-event-searches/post/responses/200/content/application~1json/examples/No results"]}},"schemaId":"components/schemas/AssetDownloadEventSearch","exampleIds":["paths/~1asset-download-event-searches/post/responses/200/content/application~1json/examples/Results with paged events without aggregations","paths/~1asset-download-event-searches/post/responses/200/content/application~1json/examples/Results with paged events with aggregations","paths/~1asset-download-event-searches/post/responses/200/content/application~1json/examples/Results without paged events with terms bucket aggregations","paths/~1asset-download-event-searches/post/responses/200/content/application~1json/examples/Results without paged events with multiple terms bucket aggregations","paths/~1asset-download-event-searches/post/responses/200/content/application~1json/examples/Results without paged events with date histogram bucket aggregations","paths/~1asset-download-event-searches/post/responses/200/content/application~1json/examples/No results"]},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1asset-download-event-searches/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AssetDownloadEventSearch","exampleIds":["paths/~1asset-download-event-searches/post/responses/200/content/application~1json/examples/Results with paged events without aggregations","paths/~1asset-download-event-searches/post/responses/200/content/application~1json/examples/Results with paged events with aggregations","paths/~1asset-download-event-searches/post/responses/200/content/application~1json/examples/Results without paged events with terms bucket aggregations","paths/~1asset-download-event-searches/post/responses/200/content/application~1json/examples/Results without paged events with multiple terms bucket aggregations","paths/~1asset-download-event-searches/post/responses/200/content/application~1json/examples/Results without paged events with date histogram bucket aggregations","paths/~1asset-download-event-searches/post/responses/200/content/application~1json/examples/No results"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AssetDownloadEventSearch","exampleIds":["paths/~1asset-download-event-searches/post/responses/200/content/application~1json/examples/Results with paged events without aggregations","paths/~1asset-download-event-searches/post/responses/200/content/application~1json/examples/Results with paged events with aggregations","paths/~1asset-download-event-searches/post/responses/200/content/application~1json/examples/Results without paged events with terms bucket aggregations","paths/~1asset-download-event-searches/post/responses/200/content/application~1json/examples/Results without paged events with multiple terms bucket aggregations","paths/~1asset-download-event-searches/post/responses/200/content/application~1json/examples/Results without paged events with date histogram bucket aggregations","paths/~1asset-download-event-searches/post/responses/200/content/application~1json/examples/No results"]}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/asset-download-events/postassetdownloadeventsearch"}],"panels":[]}]},"httpPath":"/asset-download-event-searches"}],"content":{"contentType":"group","meta":{"name":"Asset Download Events"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Asset Download Events","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/asset-download-events/postassetdownloadeventsearch"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset Download Event Search"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" allows you to search and aggregate over "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset Download Events"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Criteria can be constructed based on exact or ranged comparison of the queryable event fields listed in the request schema below."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Some fields like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USER_TYPE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DOWNLOAD_TYPE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" have a fixed set of possible values which can be determined from the response scheme below."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The logical operators "},"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":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NOT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are provided to support complex queries based on multiple fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A list of sorts can also be provided to control the order in the which the results are returned."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only the ids of referenced resources such as "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Portals"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Portal"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are provided in the response, which can then be used to GET the full resources."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Aggregations operations can also be performed on the events described by the criteria, in order to, for example"},"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":"Search across all downloads and count the number of downloads for each asset"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search downloads for a specific user and count the number of downloads per month"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note, an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/asset-download-events/postassetdownloadeventsearch"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset Download Event Search"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will only allow you to page to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"10,000"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" but values returned in any aggregations and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"totalResults"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property will be correct."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/asset-download-event-searches","summary":"Search for asset download events","prefix":{"name":"post","color":"post"},"badges":[],"link":"/asset-download-events/postassetdownloadeventsearch","deprecated":false}]}]}]}]}},{"type":"separator","label":"Field","content":null},{"type":"group","label":"Fields","link":"/dash/openapi/fields","routeSlug":"/dash/openapi/fields","items":[{"label":"Get all fields","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/fields/getfields","routeSlug":"/dash/openapi/fields/getfields","metadata":{"seo":{"title":"Get all fields","description":"Get all Field resources ordered by Field.name."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getFields","name":"Get all fields","isWebhook":false,"pointer":"/paths/~1fields/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all fields","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":"Get all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources ordered by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field.name"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/fields","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","4XX"],"pointer":"/fields","href":"fields/getfields","openApiOperationId":"getFields","summary":"Get all fields"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_34"}},"schemaId":"schema_34"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1fields/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_34","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_34"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fields/getfields"}],"panels":[]}]},"httpPath":"/fields"},{"label":"Create a field","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/fields/postfield","routeSlug":"/dash/openapi/fields/postfield","metadata":{"seo":{"title":"Create a field","description":"Create a Field resource."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postField","name":"Create a field","isWebhook":false,"pointer":"/paths/~1fields/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a field","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":"Create a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FieldRequest"}},"schemaId":"components/schemas/FieldRequest","pointer":"/paths/~1fields/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/fields","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/FieldRequest"}},"responseCodes":["200","4XX"],"pointer":"/fields","href":"fields/postfield","openApiOperationId":"postField","summary":"Create a field"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/FieldRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FieldRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FieldWithPermittedActions"}},"schemaId":"components/schemas/FieldWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1fields/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/FieldWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FieldWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fields/postfield"}],"panels":[]}]},"httpPath":"/fields"},{"label":"Get a field","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/fields/getfield","routeSlug":"/dash/openapi/fields/getfield","metadata":{"seo":{"title":"Get a field","description":"Get a Field resource."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getField","name":"Get a field","isWebhook":false,"pointer":"/paths/~1fields~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a field","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":"Get a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field.hasFixedOptions = true"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources for this "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be retrieved via an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#/dash/openapi/field-options/postfieldoptionsearch"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOptionSearch"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_25","description":"The unique ID of the field","required":true,"example":"cfb665ca-ce35-4418-b9d5-70ee815db4bd"}],"pointer":"/paths/~1fields~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/fields/{id}","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"cfb665ca-ce35-4418-b9d5-70ee815db4bd","schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","4XX"],"pointer":"/fields/{id}","href":"fields/getfield","openApiOperationId":"getField","summary":"Get a field"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FieldWithPermittedActions"}},"schemaId":"components/schemas/FieldWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1fields~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/FieldWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FieldWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fields/getfield"}],"panels":[]}]},"httpPath":"/fields/{id}"},{"label":"Update a field","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/fields/patchfield","routeSlug":"/dash/openapi/fields/patchfield","metadata":{"seo":{"title":"Update a field","description":"Update a Field resource."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchField","name":"Update a field","isWebhook":false,"pointer":"/paths/~1fields~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a field","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":"Update a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_25","description":"The unique ID of the field","required":true,"example":"cfb665ca-ce35-4418-b9d5-70ee815db4bd"}],"pointer":"/paths/~1fields~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FieldPatchRequest"}},"schemaId":"components/schemas/FieldPatchRequest","pointer":"/paths/~1fields~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/fields/{id}","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"cfb665ca-ce35-4418-b9d5-70ee815db4bd","schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/FieldPatchRequest"}},"responseCodes":["200","4XX"],"pointer":"/fields/{id}","href":"fields/patchfield","openApiOperationId":"patchField","summary":"Update a field"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/FieldPatchRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FieldPatchRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FieldWithPermittedActions"}},"schemaId":"components/schemas/FieldWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1fields~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/FieldWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FieldWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fields/patchfield"}],"panels":[]}]},"httpPath":"/fields/{id}"},{"label":"Delete a field","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/fields/deletefield","routeSlug":"/dash/openapi/fields/deletefield","metadata":{"seo":{"title":"Delete a field","description":"Delete a Field resource."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteField","name":"Delete a field","isWebhook":false,"pointer":"/paths/~1fields~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a field","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":"Delete a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_25","description":"The unique ID of the field","required":true,"example":"cfb665ca-ce35-4418-b9d5-70ee815db4bd"}],"pointer":"/paths/~1fields~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/fields/{id}","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"cfb665ca-ce35-4418-b9d5-70ee815db4bd","schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","4XX"],"pointer":"/fields/{id}","href":"fields/deletefield","openApiOperationId":"deleteField","summary":"Delete a field"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1fields~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fields/deletefield"}],"panels":[]}]},"httpPath":"/fields/{id}"}],"content":{"contentType":"group","meta":{"name":"Fields"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fields","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources define the custom metadata schema for "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources in your Dash account."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Every "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in your Dash account can be assigned a value or values for each "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" you define."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type and structure of the data stored against the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for each "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is described by a series of properties specified on the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/fields","summary":"Get all fields","prefix":{"name":"get","color":"get"},"badges":[],"link":"/fields/getfields","deprecated":false},{"title":"/fields","summary":"Create a field","prefix":{"name":"post","color":"post"},"badges":[],"link":"/fields/postfield","deprecated":false},{"title":"/fields/{id}","summary":"Get a field","prefix":{"name":"get","color":"get"},"badges":[],"link":"/fields/getfield","deprecated":false},{"title":"/fields/{id}","summary":"Update a field","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/fields/patchfield","deprecated":false},{"title":"/fields/{id}","summary":"Delete a field","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/fields/deletefield","deprecated":false}]}]}]}]}},{"type":"group","label":"Field Options","link":"/dash/openapi/field-options","routeSlug":"/dash/openapi/field-options","items":[{"label":"Create a field option","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/field-options/postfieldoption","routeSlug":"/dash/openapi/field-options/postfieldoption","metadata":{"seo":{"title":"Create a field option","description":"Create a new FieldOption resource adding it to the set of valid choices for an Field where Field.hasFixedOptions = true."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postFieldOption","name":"Create a field option","isWebhook":false,"pointer":"/paths/~1field-options/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a field option","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":"Create a new "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource adding it to the set of valid choices for an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field.hasFixedOptions = true"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FieldOptionRequest","exampleIds":["paths/~1field-options/post/requestBody/content/application~1json/examples/Create at top level","paths/~1field-options/post/requestBody/content/application~1json/examples/Create at sub level"]}},"schemaId":"components/schemas/FieldOptionRequest","exampleIds":["paths/~1field-options/post/requestBody/content/application~1json/examples/Create at top level","paths/~1field-options/post/requestBody/content/application~1json/examples/Create at sub level"],"pointer":"/paths/~1field-options/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/field-options","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/FieldOptionRequest","exampleIds":["paths/~1field-options/post/requestBody/content/application~1json/examples/Create at top level","paths/~1field-options/post/requestBody/content/application~1json/examples/Create at sub level"]}},"responseCodes":["200","4XX"],"pointer":"/field-options","href":"field-options/postfieldoption","openApiOperationId":"postFieldOption","summary":"Create a field option"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/FieldOptionRequest","exampleIds":["paths/~1field-options/post/requestBody/content/application~1json/examples/Create at top level","paths/~1field-options/post/requestBody/content/application~1json/examples/Create at sub level"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FieldOptionRequest","exampleIds":["paths/~1field-options/post/requestBody/content/application~1json/examples/Create at top level","paths/~1field-options/post/requestBody/content/application~1json/examples/Create at sub level"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FieldOptionWithPermittedActions","exampleIds":["paths/~1field-options/post/responses/200/content/application~1json/examples/Create at top level","paths/~1field-options/post/responses/200/content/application~1json/examples/Create at sub level"]}},"schemaId":"components/schemas/FieldOptionWithPermittedActions","exampleIds":["paths/~1field-options/post/responses/200/content/application~1json/examples/Create at top level","paths/~1field-options/post/responses/200/content/application~1json/examples/Create at sub level"]},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1field-options/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/FieldOptionWithPermittedActions","exampleIds":["paths/~1field-options/post/responses/200/content/application~1json/examples/Create at top level","paths/~1field-options/post/responses/200/content/application~1json/examples/Create at sub level"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FieldOptionWithPermittedActions","exampleIds":["paths/~1field-options/post/responses/200/content/application~1json/examples/Create at top level","paths/~1field-options/post/responses/200/content/application~1json/examples/Create at sub level"]}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/field-options/postfieldoption"}],"panels":[]}]},"httpPath":"/field-options"},{"label":"Get a field option","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/field-options/getfieldoption","routeSlug":"/dash/openapi/field-options/getfieldoption","metadata":{"seo":{"title":"Get a field option","description":"Get an FieldOption resource for an Field where Field.hasFixedOptions = true."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getFieldOption","name":"Get a field option","isWebhook":false,"pointer":"/paths/~1field-options~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a field option","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":"Get an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource for an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field.hasFixedOptions = true"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption"},"children":[]}]}]}]}],"required":true}],"pointer":"/paths/~1field-options~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/field-options/{id}","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","4XX"],"pointer":"/field-options/{id}","href":"field-options/getfieldoption","openApiOperationId":"getFieldOption","summary":"Get a field option"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FieldOptionWithPermittedActions","exampleIds":["paths/~1field-options~1{id}/get/responses/200/content/application~1json/examples/Without parent","paths/~1field-options~1{id}/get/responses/200/content/application~1json/examples/With parent"]}},"schemaId":"components/schemas/FieldOptionWithPermittedActions","exampleIds":["paths/~1field-options~1{id}/get/responses/200/content/application~1json/examples/Without parent","paths/~1field-options~1{id}/get/responses/200/content/application~1json/examples/With parent"]},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1field-options~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/FieldOptionWithPermittedActions","exampleIds":["paths/~1field-options~1{id}/get/responses/200/content/application~1json/examples/Without parent","paths/~1field-options~1{id}/get/responses/200/content/application~1json/examples/With parent"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FieldOptionWithPermittedActions","exampleIds":["paths/~1field-options~1{id}/get/responses/200/content/application~1json/examples/Without parent","paths/~1field-options~1{id}/get/responses/200/content/application~1json/examples/With parent"]}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/field-options/getfieldoption"}],"panels":[]}]},"httpPath":"/field-options/{id}"},{"label":"Delete a field option","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/field-options/deletefieldoption","routeSlug":"/dash/openapi/field-options/deletefieldoption","metadata":{"seo":{"title":"Delete a field option","description":"Delete an FieldOption resource, removing it from the set of valid choices for an Field."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteFieldOption","name":"Delete a field option","isWebhook":false,"pointer":"/paths/~1field-options~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a field option","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":"Delete an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource, removing it from the set of valid choices for an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"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":"When deleting an option within a hierarchy of options all options in the hierarchy below the one being deleted will also be deleted."},"children":[]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption"},"children":[]}]}]}]}],"required":true}],"pointer":"/paths/~1field-options~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/field-options/{id}","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","4XX"],"pointer":"/field-options/{id}","href":"field-options/deletefieldoption","openApiOperationId":"deleteFieldOption","summary":"Delete a field option"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1field-options~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/field-options/deletefieldoption"}],"panels":[]}]},"httpPath":"/field-options/{id}"},{"label":"Create field options","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/field-options/postfieldoptionbatches","routeSlug":"/dash/openapi/field-options/postfieldoptionbatches","metadata":{"seo":{"title":"Create field options","description":"Create new FieldOption resources adding them to the set of valid choices for an Field where Field.hasFixedOptions = true."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postFieldOptionBatches","name":"Create field options","isWebhook":false,"pointer":"/paths/~1field-option-batches/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create field options","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":"Create new "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources adding them to the set of valid choices for an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field.hasFixedOptions = true"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FieldOptionBatchRequest"}},"schemaId":"components/schemas/FieldOptionBatchRequest","pointer":"/paths/~1field-option-batches/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/field-option-batches","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/FieldOptionBatchRequest"}},"responseCodes":["200","4XX"],"pointer":"/field-option-batches","href":"field-options/postfieldoptionbatches","openApiOperationId":"postFieldOptionBatches","summary":"Create field options"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/FieldOptionBatchRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FieldOptionBatchRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FieldOptionBatch"}},"schemaId":"components/schemas/FieldOptionBatch"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1field-option-batches/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/FieldOptionBatch","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FieldOptionBatch"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/field-options/postfieldoptionbatches"}],"panels":[]}]},"httpPath":"/field-option-batches"},{"label":"Search for field options","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/field-options/postfieldoptionsearch","routeSlug":"/dash/openapi/field-options/postfieldoptionsearch","metadata":{"seo":{"title":"Search for field options","description":"Create a new FieldOptionSearch"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postFieldOptionSearch","name":"Search for field options","isWebhook":false,"pointer":"/paths/~1field-option-searches/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search for field options","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":"Create a new "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#/dash/openapi/field-options/postfieldoptionsearch"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOptionSearch"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The most commmon uses of an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#/dash/openapi/field-options/postfieldoptionsearch"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOptionSearch"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is to retrieve the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources for an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FIELD_ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field criterion."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field.hierarchical = true"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" it is recommended to retrieve each level of the tree via a separate search using "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PARENT_ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field criteria."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FieldOptionSearchRequest","exampleIds":["paths/~1field-option-searches/post/requestBody/content/application~1json/examples/Search for top level options","paths/~1field-option-searches/post/requestBody/content/application~1json/examples/Search for sub level options","paths/~1field-option-searches/post/requestBody/content/application~1json/examples/Search for all options for a field"]}},"schemaId":"components/schemas/FieldOptionSearchRequest","exampleIds":["paths/~1field-option-searches/post/requestBody/content/application~1json/examples/Search for top level options","paths/~1field-option-searches/post/requestBody/content/application~1json/examples/Search for sub level options","paths/~1field-option-searches/post/requestBody/content/application~1json/examples/Search for all options for a field"],"pointer":"/paths/~1field-option-searches/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/field-option-searches","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/FieldOptionSearchRequest","exampleIds":["paths/~1field-option-searches/post/requestBody/content/application~1json/examples/Search for top level options","paths/~1field-option-searches/post/requestBody/content/application~1json/examples/Search for sub level options","paths/~1field-option-searches/post/requestBody/content/application~1json/examples/Search for all options for a field"]}},"responseCodes":["200","4XX"],"pointer":"/field-option-searches","href":"field-options/postfieldoptionsearch","openApiOperationId":"postFieldOptionSearch","summary":"Search for field options"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/FieldOptionSearchRequest","exampleIds":["paths/~1field-option-searches/post/requestBody/content/application~1json/examples/Search for top level options","paths/~1field-option-searches/post/requestBody/content/application~1json/examples/Search for sub level options","paths/~1field-option-searches/post/requestBody/content/application~1json/examples/Search for all options for a field"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FieldOptionSearchRequest","exampleIds":["paths/~1field-option-searches/post/requestBody/content/application~1json/examples/Search for top level options","paths/~1field-option-searches/post/requestBody/content/application~1json/examples/Search for sub level options","paths/~1field-option-searches/post/requestBody/content/application~1json/examples/Search for all options for a field"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FieldOptionSearch","exampleIds":["paths/~1field-option-searches/post/responses/200/content/application~1json/examples/Search for top level options","paths/~1field-option-searches/post/responses/200/content/application~1json/examples/Search for sub level options","paths/~1field-option-searches/post/responses/200/content/application~1json/examples/Search for all options for a field"]}},"schemaId":"components/schemas/FieldOptionSearch","exampleIds":["paths/~1field-option-searches/post/responses/200/content/application~1json/examples/Search for top level options","paths/~1field-option-searches/post/responses/200/content/application~1json/examples/Search for sub level options","paths/~1field-option-searches/post/responses/200/content/application~1json/examples/Search for all options for a field"]},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1field-option-searches/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/FieldOptionSearch","exampleIds":["paths/~1field-option-searches/post/responses/200/content/application~1json/examples/Search for top level options","paths/~1field-option-searches/post/responses/200/content/application~1json/examples/Search for sub level options","paths/~1field-option-searches/post/responses/200/content/application~1json/examples/Search for all options for a field"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FieldOptionSearch","exampleIds":["paths/~1field-option-searches/post/responses/200/content/application~1json/examples/Search for top level options","paths/~1field-option-searches/post/responses/200/content/application~1json/examples/Search for sub level options","paths/~1field-option-searches/post/responses/200/content/application~1json/examples/Search for all options for a field"]}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/field-options/postfieldoptionsearch"}],"panels":[]}]},"httpPath":"/field-option-searches"}],"content":{"contentType":"group","meta":{"name":"Field Options"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Field Options","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources define the set of valid choices for a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field.hasFixedOptions = true"},"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":"An "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has human-readable "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption.value"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption.position"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" which determines the order in which it appears in relation to the other "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources for a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field"},"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":"If "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field.hierarchical = true"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" then "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption.parent"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" which is the parent node of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the tree."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption.position"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" then determines the order in which the option appears in relation to the other options with the same "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption.parent"},"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":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource intentionally does not include the list of child "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is to prevent costly loading of large "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" tree structures."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption.leaf"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption.numberOfChildren"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" properties can be used to determine the number of children for a node, but it is recommended to implement a combination of lazy-loading strategies using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/field-options/getfieldoption"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET Field Option"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/field-options/postfieldoptionsearch"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST Field Option Searches"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources for retrieval."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"e.g. Doing a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/field-options/getfieldoption"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET Field Option"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption.id"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value found in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset.metadata.values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will give the complete branch of the tree necessary in the context of the viewing that "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" via the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption.parent"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For traversing down an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" tree "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/field-options/postfieldoptionsearch"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST Field Option Searches"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be used to first get all the top-level options and then each sub level as and when needed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Searching allows you to find "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources in your Dash matching specific criteria"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Criteria can be constructed based on direct comparison or pattern matching of a set of fixed "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" properties."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The logical operators "},"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":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NOT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are provided to support complex queries based on multiple fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A list of sorts can also be provided to control the order in the which the results are returned."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/field-options","summary":"Create a field option","prefix":{"name":"post","color":"post"},"badges":[],"link":"/field-options/postfieldoption","deprecated":false},{"title":"/field-options/{id}","summary":"Get a field option","prefix":{"name":"get","color":"get"},"badges":[],"link":"/field-options/getfieldoption","deprecated":false},{"title":"/field-options/{id}","summary":"Delete a field option","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/field-options/deletefieldoption","deprecated":false},{"title":"/field-option-batches","summary":"Create field options","prefix":{"name":"post","color":"post"},"badges":[],"link":"/field-options/postfieldoptionbatches","deprecated":false},{"title":"/field-option-searches","summary":"Search for field options","prefix":{"name":"post","color":"post"},"badges":[],"link":"/field-options/postfieldoptionsearch","deprecated":false}]}]}]}]}},{"type":"group","label":"Field Option Images","link":"/dash/openapi/field-option-images","routeSlug":"/dash/openapi/field-option-images","items":[{"label":"Get field option images","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/field-option-images/postfieldoptionimagebatches","routeSlug":"/dash/openapi/field-option-images/postfieldoptionimagebatches","metadata":{"seo":{"title":"Get field option images","description":"Get Field Option Images in batches"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postFieldOptionImageBatches","name":"Get field option images","isWebhook":false,"pointer":"/paths/~1field-option-images/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get field option images","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get Field Option Images in batches\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FieldOptionImageBatchRequest","exampleIds":["paths/~1field-option-images/post/requestBody/content/application~1json/examples/Get field option images for a few field options"]}},"schemaId":"components/schemas/FieldOptionImageBatchRequest","exampleIds":["paths/~1field-option-images/post/requestBody/content/application~1json/examples/Get field option images for a few field options"],"pointer":"/paths/~1field-option-images/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/field-option-images","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/FieldOptionImageBatchRequest","exampleIds":["paths/~1field-option-images/post/requestBody/content/application~1json/examples/Get field option images for a few field options"]}},"responseCodes":["200","4XX"],"pointer":"/field-option-images","href":"field-option-images/postfieldoptionimagebatches","openApiOperationId":"postFieldOptionImageBatches","summary":"Get field option images"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/FieldOptionImageBatchRequest","exampleIds":["paths/~1field-option-images/post/requestBody/content/application~1json/examples/Get field option images for a few field options"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FieldOptionImageBatchRequest","exampleIds":["paths/~1field-option-images/post/requestBody/content/application~1json/examples/Get field option images for a few field options"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FieldOptionImageBatch","exampleIds":["paths/~1field-option-images/post/responses/200/content/application~1json/examples/Get field option images for a few field options"]}},"schemaId":"components/schemas/FieldOptionImageBatch","exampleIds":["paths/~1field-option-images/post/responses/200/content/application~1json/examples/Get field option images for a few field options"]},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1field-option-images/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/FieldOptionImageBatch","exampleIds":["paths/~1field-option-images/post/responses/200/content/application~1json/examples/Get field option images for a few field options"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FieldOptionImageBatch","exampleIds":["paths/~1field-option-images/post/responses/200/content/application~1json/examples/Get field option images for a few field options"]}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/field-option-images/postfieldoptionimagebatches"}],"panels":[]}]},"httpPath":"/field-option-images"},{"label":"Delete a field option image","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/field-option-images/deletefieldoptionimage","routeSlug":"/dash/openapi/field-option-images/deletefieldoptionimage","metadata":{"seo":{"title":"Delete a field option image","description":"Delete a field Option Image"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteFieldOptionImage","name":"Delete a field option image","isWebhook":false,"pointer":"/paths/~1field-option-images~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a field option image","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete a field Option Image\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that the image belongs to"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1field-option-images~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/field-option-images/{id}","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","4XX"],"pointer":"/field-option-images/{id}","href":"field-option-images/deletefieldoptionimage","openApiOperationId":"deleteFieldOptionImage","summary":"Delete a field option image"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1field-option-images~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/field-option-images/deletefieldoptionimage"}],"panels":[]}]},"httpPath":"/field-option-images/{id}"},{"label":"Upload a field option image","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/field-option-images/postuploadfieldoptionimage","routeSlug":"/dash/openapi/field-option-images/postuploadfieldoptionimage","metadata":{"seo":{"title":"Upload a field option image","description":"Upload a field option image"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postUploadFieldOptionImage","name":"Upload a field option image","isWebhook":false,"pointer":"/paths/~1field-option-image-uploads/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload a field option image","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FieldOptionImageUploadRequest","exampleIds":["paths/~1field-option-image-uploads/post/requestBody/content/application~1json/examples/Get an image upload object"]}},"schemaId":"components/schemas/FieldOptionImageUploadRequest","exampleIds":["paths/~1field-option-image-uploads/post/requestBody/content/application~1json/examples/Get an image upload object"],"pointer":"/paths/~1field-option-image-uploads/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/field-option-image-uploads","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/FieldOptionImageUploadRequest","exampleIds":["paths/~1field-option-image-uploads/post/requestBody/content/application~1json/examples/Get an image upload object"]}},"responseCodes":["200","4XX"],"pointer":"/field-option-image-uploads","href":"field-option-images/postuploadfieldoptionimage","openApiOperationId":"postUploadFieldOptionImage","summary":"Upload a field option image"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/FieldOptionImageUploadRequest","exampleIds":["paths/~1field-option-image-uploads/post/requestBody/content/application~1json/examples/Get an image upload object"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FieldOptionImageUploadRequest","exampleIds":["paths/~1field-option-image-uploads/post/requestBody/content/application~1json/examples/Get an image upload object"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FieldOptionImageUpload","exampleIds":["paths/~1field-option-image-uploads/post/responses/200/content/application~1json/examples/Get an image upload object"]}},"schemaId":"components/schemas/FieldOptionImageUpload","exampleIds":["paths/~1field-option-image-uploads/post/responses/200/content/application~1json/examples/Get an image upload object"]},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1field-option-image-uploads/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/FieldOptionImageUpload","exampleIds":["paths/~1field-option-image-uploads/post/responses/200/content/application~1json/examples/Get an image upload object"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FieldOptionImageUpload","exampleIds":["paths/~1field-option-image-uploads/post/responses/200/content/application~1json/examples/Get an image upload object"]}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/field-option-images/postuploadfieldoptionimage"}],"panels":[]}]},"httpPath":"/field-option-image-uploads"}],"content":{"contentType":"group","meta":{"name":"Field Option Images"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Field Option Images","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Coming soon; "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"mailto:help@dash.app"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contact us"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if you need access to this API endpoint."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/field-option-images","summary":"Get field option images","prefix":{"name":"post","color":"post"},"badges":[],"link":"/field-option-images/postfieldoptionimagebatches","deprecated":false},{"title":"/field-option-images/{id}","summary":"Delete a field option image","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/field-option-images/deletefieldoptionimage","deprecated":false},{"title":"/field-option-image-uploads","summary":"Upload a field option image","prefix":{"name":"post","color":"post"},"badges":[],"link":"/field-option-images/postuploadfieldoptionimage","deprecated":false}]}]}]}]}},{"type":"group","label":"Field Views","link":"/dash/openapi/field-views","routeSlug":"/dash/openapi/field-views","items":[{"label":"Get all field views","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/field-views/getfieldviews","routeSlug":"/dash/openapi/field-views/getfieldviews","metadata":{"seo":{"title":"Get all field views","description":"Get all FieldViews."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getFieldViews","name":"Get all field views","isWebhook":false,"pointer":"/paths/~1field-views/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all field views","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":"Get all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Views"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldViews"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/field-views","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","4XX"],"pointer":"/field-views","href":"field-views/getfieldviews","openApiOperationId":"getFieldViews","summary":"Get all field views"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_35"}},"schemaId":"schema_35"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1field-views/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_35","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_35"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/field-views/getfieldviews"}],"panels":[]}]},"httpPath":"/field-views"}],"content":{"contentType":"group","meta":{"name":"Field Views"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Field Views","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Views"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldView"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"s provide an ordered view of a subset of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"s, which can be configured by admins.  This can be used to decide which "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"s to show alongside "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag%5D/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"s in different contexts."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/field-views","summary":"Get all field views","prefix":{"name":"get","color":"get"},"badges":[],"link":"/field-views/getfieldviews","deprecated":false}]}]}]}]}},{"type":"separator","label":"Guest Upload","content":null},{"type":"group","label":"Guest Uploads","link":"/dash/openapi/guest-uploads","routeSlug":"/dash/openapi/guest-uploads","items":[{"label":"Create a guest upload","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/guest-uploads/postguestupload","routeSlug":"/dash/openapi/guest-uploads/postguestupload","metadata":{"seo":{"title":"Create a guest upload","description":"Create a new GuestUpload URL, to share with a guest to upload files to a specified folder"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postGuestUpload","name":"Create a guest upload","isWebhook":false,"pointer":"/paths/~1guest-uploads/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a guest upload","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":"Create a new "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Guest-Uploads"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GuestUpload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" URL, to share with a guest to upload files to a specified folder"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GuestUploadRequest"}},"schemaId":"components/schemas/GuestUploadRequest","pointer":"/paths/~1guest-uploads/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/guest-uploads","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/GuestUploadRequest"}},"responseCodes":["200","4XX"],"pointer":"/guest-uploads","href":"guest-uploads/postguestupload","openApiOperationId":"postGuestUpload","summary":"Create a guest upload"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/GuestUploadRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GuestUploadRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GuestUploadWithPermittedActions"}},"schemaId":"components/schemas/GuestUploadWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1guest-uploads/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GuestUploadWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GuestUploadWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/guest-uploads/postguestupload"}],"panels":[]}]},"httpPath":"/guest-uploads"},{"label":"Get a guest upload","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/guest-uploads/getguestupload","routeSlug":"/dash/openapi/guest-uploads/getguestupload","metadata":{"seo":{"title":"Get a guest upload","description":"Get a GuestUpload"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getGuestUpload","name":"Get a guest upload","isWebhook":false,"pointer":"/paths/~1guest-uploads~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a guest upload","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":"Get a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Guest-Uploads"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GuestUpload"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Guest-Uploads"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GuestUpload"},"children":[]}]}]}]}],"required":true}],"pointer":"/paths/~1guest-uploads~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/guest-uploads/{id}","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","4XX"],"pointer":"/guest-uploads/{id}","href":"guest-uploads/getguestupload","openApiOperationId":"getGuestUpload","summary":"Get a guest upload"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GuestUploadWithPermittedActions"}},"schemaId":"components/schemas/GuestUploadWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1guest-uploads~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GuestUploadWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GuestUploadWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/guest-uploads/getguestupload"}],"panels":[]}]},"httpPath":"/guest-uploads/{id}"},{"label":"Update a guest upload","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/guest-uploads/patchguestupload","routeSlug":"/dash/openapi/guest-uploads/patchguestupload","metadata":{"seo":{"title":"Update a guest upload","description":"Patch a GuestUpload"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchGuestUpload","name":"Update a guest upload","isWebhook":false,"pointer":"/paths/~1guest-uploads~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a guest upload","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":"Patch a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Guest-Uploads"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GuestUpload"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Guest-Uploads"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GuestUpload"},"children":[]}]}]}]}],"required":true}],"pointer":"/paths/~1guest-uploads~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GuestUploadPatchRequest"}},"schemaId":"components/schemas/GuestUploadPatchRequest","pointer":"/paths/~1guest-uploads~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/guest-uploads/{id}","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/GuestUploadPatchRequest"}},"responseCodes":["200","4XX"],"pointer":"/guest-uploads/{id}","href":"guest-uploads/patchguestupload","openApiOperationId":"patchGuestUpload","summary":"Update a guest upload"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/GuestUploadPatchRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GuestUploadPatchRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GuestUploadWithPermittedActions"}},"schemaId":"components/schemas/GuestUploadWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1guest-uploads~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GuestUploadWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GuestUploadWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/guest-uploads/patchguestupload"}],"panels":[]}]},"httpPath":"/guest-uploads/{id}"},{"label":"Delete a GuestUpload","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/guest-uploads/deleteguestupload","routeSlug":"/dash/openapi/guest-uploads/deleteguestupload","metadata":{"seo":{"title":"Delete a GuestUpload","description":"Delete a GuestUpload."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteGuestUpload","name":"Delete a GuestUpload","isWebhook":false,"pointer":"/paths/~1guest-uploads~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a GuestUpload","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":"Delete a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Guest-Uploads"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GuestUpload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Guest-Uploads"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GuestUpload"},"children":[]}]}]}]}],"required":true}],"pointer":"/paths/~1guest-uploads~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/guest-uploads/{id}","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","4XX"],"pointer":"/guest-uploads/{id}","href":"guest-uploads/deleteguestupload","openApiOperationId":"deleteGuestUpload","summary":"Delete a GuestUpload"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1guest-uploads~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/guest-uploads/deleteguestupload"}],"panels":[]}]},"httpPath":"/guest-uploads/{id}"},{"label":"Search for guest uploads","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/guest-uploads/postguestuploadsearch","routeSlug":"/dash/openapi/guest-uploads/postguestuploadsearch","metadata":{"seo":{"title":"Search for guest uploads","description":"Create a new GuestUploadSearch"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postGuestUploadSearch","name":"Search for guest uploads","isWebhook":false,"pointer":"/paths/~1guest-upload-searches/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search for guest uploads","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":"Create a new "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/guest-uploads/postguestuploadsearch"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GuestUploadSearch"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GuestUploadSearchRequest"}},"schemaId":"components/schemas/GuestUploadSearchRequest","pointer":"/paths/~1guest-upload-searches/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/guest-upload-searches","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/GuestUploadSearchRequest"}},"responseCodes":["200","4XX"],"pointer":"/guest-upload-searches","href":"guest-uploads/postguestuploadsearch","openApiOperationId":"postGuestUploadSearch","summary":"Search for guest uploads"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/GuestUploadSearchRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GuestUploadSearchRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GuestUploadSearch"}},"schemaId":"components/schemas/GuestUploadSearch"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1guest-upload-searches/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GuestUploadSearch","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GuestUploadSearch"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/guest-uploads/postguestuploadsearch"}],"panels":[]}]},"httpPath":"/guest-upload-searches"}],"content":{"contentType":"group","meta":{"name":"Guest Uploads"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Guest Uploads","showPageActions":true},{"nodeType":"markdoc","content":"Guest Uploads allow guests to upload assets to a specific Folder."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/guest-uploads","summary":"Create a guest upload","prefix":{"name":"post","color":"post"},"badges":[],"link":"/guest-uploads/postguestupload","deprecated":false},{"title":"/guest-uploads/{id}","summary":"Get a guest upload","prefix":{"name":"get","color":"get"},"badges":[],"link":"/guest-uploads/getguestupload","deprecated":false},{"title":"/guest-uploads/{id}","summary":"Update a guest upload","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/guest-uploads/patchguestupload","deprecated":false},{"title":"/guest-uploads/{id}","summary":"Delete a GuestUpload","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/guest-uploads/deleteguestupload","deprecated":false},{"title":"/guest-upload-searches","summary":"Search for guest uploads","prefix":{"name":"post","color":"post"},"badges":[],"link":"/guest-uploads/postguestuploadsearch","deprecated":false}]}]}]}]}},{"type":"group","label":"Guest Upload Access Tokens","link":"/dash/openapi/guest-upload-access-tokens","routeSlug":"/dash/openapi/guest-upload-access-tokens","items":[{"label":"Create a guest upload access token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/guest-upload-access-tokens/postguestuploadaccesstoken","routeSlug":"/dash/openapi/guest-upload-access-tokens/postguestuploadaccesstoken","metadata":{"seo":{"title":"Create a guest upload access token","description":"Create an access token for making requests as a GuestUpload user.  Using this access token, the guest can upload assets."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postGuestUploadAccessToken","name":"Create a guest upload access token","isWebhook":false,"pointer":"/paths/~1guest-upload-access-tokens/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a guest upload access token","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":"Create an access token for making requests as a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Guest-Uploads"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GuestUpload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" user.  Using this access token, the guest can upload assets."},"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":"This endpoint is unauthenticated. Do not send a Bearer Token in the Authorization Header"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GuestUploadAccessTokenRequest"}},"schemaId":"components/schemas/GuestUploadAccessTokenRequest","pointer":"/paths/~1guest-upload-access-tokens/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/guest-upload-access-tokens","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/GuestUploadAccessTokenRequest"}},"responseCodes":["200","4XX"],"pointer":"/guest-upload-access-tokens","href":"guest-upload-access-tokens/postguestuploadaccesstoken","openApiOperationId":"postGuestUploadAccessToken","summary":"Create a guest upload access token"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/GuestUploadAccessTokenRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GuestUploadAccessTokenRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccessTokenWithPermittedActions"}},"schemaId":"components/schemas/AccessTokenWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1guest-upload-access-tokens/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AccessTokenWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccessTokenWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/guest-upload-access-tokens/postguestuploadaccesstoken"}],"panels":[]}]},"httpPath":"/guest-upload-access-tokens"}],"content":{"contentType":"group","meta":{"name":"Guest Upload Access Tokens"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Guest Upload Access Tokens","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/guest-upload-access-tokens","summary":"Create a guest upload access token","prefix":{"name":"post","color":"post"},"badges":[],"link":"/guest-upload-access-tokens/postguestuploadaccesstoken","deprecated":false}]}]}]}]}},{"type":"group","label":"Guest Upload Emails","link":"/dash/openapi/guest-upload-emails","routeSlug":"/dash/openapi/guest-upload-emails","items":[{"label":"Email a link to a guest upload","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/guest-upload-emails/postguestuploademail","routeSlug":"/dash/openapi/guest-upload-emails/postguestuploademail","metadata":{"seo":{"title":"Email a link to a guest upload","description":"Send a GuestUpload URL via email to a specified email address"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postGuestUploadEmail","name":"Email a link to a guest upload","isWebhook":false,"pointer":"/paths/~1guest-upload-emails/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Email a link to a guest upload","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":"Send a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Guest-Uploads"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GuestUpload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" URL via email to a specified email address"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GuestUploadEmailRequest"}},"schemaId":"components/schemas/GuestUploadEmailRequest","pointer":"/paths/~1guest-upload-emails/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/guest-upload-emails","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/GuestUploadEmailRequest"}},"responseCodes":["204","4XX"],"pointer":"/guest-upload-emails","href":"guest-upload-emails/postguestuploademail","openApiOperationId":"postGuestUploadEmail","summary":"Email a link to a guest upload"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/GuestUploadEmailRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GuestUploadEmailRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1guest-upload-emails/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/guest-upload-emails/postguestuploademail"}],"panels":[]}]},"httpPath":"/guest-upload-emails"}],"content":{"contentType":"group","meta":{"name":"Guest Upload Emails"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Guest Upload Emails","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/guest-upload-emails","summary":"Email a link to a guest upload","prefix":{"name":"post","color":"post"},"badges":[],"link":"/guest-upload-emails/postguestuploademail","deprecated":false}]}]}]}]}},{"type":"group","label":"Publicly Available Guest Upload Data","link":"/dash/openapi/publicly-available-guest-upload-data","routeSlug":"/dash/openapi/publicly-available-guest-upload-data","items":[{"label":"Get public guest upload data","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/publicly-available-guest-upload-data/getpubliclyavailableguestuploaddata","routeSlug":"/dash/openapi/publicly-available-guest-upload-data/getpubliclyavailableguestuploaddata","metadata":{"seo":{"title":"Get public guest upload data","description":"Get the publicly available data for a Guest Upload by subdomain and slug"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPubliclyAvailableGuestUploadData","name":"Get public guest upload data","isWebhook":false,"pointer":"/paths/~1subdomains~1{subdomain}~1publicly-available-guest-upload-data~1{slug}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get public guest upload data","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get the publicly available data for a Guest Upload by subdomain and slug\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The subdomain of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Guest-Uploads"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GuestUpload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" belongs to"},"children":[]}]}]}],"required":true},{"name":"slug","in":"path","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The slug of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Guest-Uploads"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GuestUpload"},"children":[]}]}]}]}],"required":true}],"pointer":"/paths/~1subdomains~1{subdomain}~1publicly-available-guest-upload-data~1{slug}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/subdomains/{subdomain}/publicly-available-guest-upload-data/{slug}","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"schema_25"},{"name":"slug","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","4XX"],"pointer":"/subdomains/{subdomain}/publicly-available-guest-upload-data/{slug}","href":"publicly-available-guest-upload-data/getpubliclyavailableguestuploaddata","openApiOperationId":"getPubliclyAvailableGuestUploadData","summary":"Get public guest upload data"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PubliclyAvailableGuestUploadDataWithPermittedActions"}},"schemaId":"components/schemas/PubliclyAvailableGuestUploadDataWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1subdomains~1{subdomain}~1publicly-available-guest-upload-data~1{slug}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PubliclyAvailableGuestUploadDataWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PubliclyAvailableGuestUploadDataWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/publicly-available-guest-upload-data/getpubliclyavailableguestuploaddata"}],"panels":[]}]},"httpPath":"/subdomains/{subdomain}/publicly-available-guest-upload-data/{slug}"}],"content":{"contentType":"group","meta":{"name":"Publicly Available Guest Upload Data"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Publicly Available Guest Upload Data","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/subdomains/{subdomain}/publicly-available-guest-upload-data/{slug}","summary":"Get public guest upload data","prefix":{"name":"get","color":"get"},"badges":[],"link":"/publicly-available-guest-upload-data/getpubliclyavailableguestuploaddata","deprecated":false}]}]}]}]}},{"type":"separator","label":"Integration","content":null},{"type":"group","label":"Corebook","link":"/dash/openapi/corebook","routeSlug":"/dash/openapi/corebook","items":[{"label":"Get the account Corebook settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/corebook/getcorebooksettings","routeSlug":"/dash/openapi/corebook/getcorebooksettings","metadata":{"seo":{"title":"Get the account Corebook settings","description":"Get the account Corebook settings"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCorebookSettings","name":"Get the account Corebook settings","isWebhook":false,"pointer":"/paths/~1corebook-settings/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get the account Corebook settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/corebook-settings","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","4XX"],"pointer":"/corebook-settings","href":"corebook/getcorebooksettings","openApiOperationId":"getCorebookSettings","summary":"Get the account Corebook settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CorebookSettingsWithPermittedActions"}},"schemaId":"components/schemas/CorebookSettingsWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1corebook-settings/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CorebookSettingsWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CorebookSettingsWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/corebook/getcorebooksettings"}],"panels":[]}]},"httpPath":"/corebook-settings"},{"label":"Update the account Corebook settings","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/corebook/putcorebooksettings","routeSlug":"/dash/openapi/corebook/putcorebooksettings","metadata":{"seo":{"title":"Update the account Corebook settings","description":"Update the account Corebook settings"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"putCorebookSettings","name":"Update the account Corebook settings","isWebhook":false,"pointer":"/paths/~1corebook-settings/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update the account Corebook settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CorebookSettingsRequest"}},"schemaId":"components/schemas/CorebookSettingsRequest","pointer":"/paths/~1corebook-settings/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/corebook-settings","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CorebookSettingsRequest"}},"responseCodes":["200","4XX"],"pointer":"/corebook-settings","href":"corebook/putcorebooksettings","openApiOperationId":"putCorebookSettings","summary":"Update the account Corebook settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/CorebookSettingsRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CorebookSettingsRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CorebookSettingsWithPermittedActions"}},"schemaId":"components/schemas/CorebookSettingsWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1corebook-settings/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CorebookSettingsWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CorebookSettingsWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/corebook/putcorebooksettings"}],"panels":[]}]},"httpPath":"/corebook-settings"}],"content":{"contentType":"group","meta":{"name":"Corebook"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Corebook","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"At present the Corebook integration with Dash is configured entirely within Corebook.  However, Dash allows admins to set their "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/corebook/putcorebooksettings"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CorebookSettings.corebookUrl"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which will then show up as a \"Brand\" link to all users."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/corebook-settings","summary":"Get the account Corebook settings","prefix":{"name":"get","color":"get"},"badges":[],"link":"/corebook/getcorebooksettings","deprecated":false},{"title":"/corebook-settings","summary":"Update the account Corebook settings","prefix":{"name":"put","color":"put"},"badges":[],"link":"/corebook/putcorebooksettings","deprecated":false}]}]}]}]}},{"type":"group","label":"Custom","link":"/dash/openapi/custom","routeSlug":"/dash/openapi/custom","items":[{"label":"Get the account custom integration settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/custom/getcustomintegrationsettings","routeSlug":"/dash/openapi/custom/getcustomintegrationsettings","metadata":{"seo":{"title":"Get the account custom integration settings","description":"Get the account custom integration settings"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCustomIntegrationSettings","name":"Get the account custom integration settings","isWebhook":false,"pointer":"/paths/~1custom-integration-settings/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get the account custom integration settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/custom-integration-settings","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","4XX"],"pointer":"/custom-integration-settings","href":"custom/getcustomintegrationsettings","openApiOperationId":"getCustomIntegrationSettings","summary":"Get the account custom integration settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomIntegrationSettingsWithPermittedActions"}},"schemaId":"components/schemas/CustomIntegrationSettingsWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1custom-integration-settings/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CustomIntegrationSettingsWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomIntegrationSettingsWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom/getcustomintegrationsettings"}],"panels":[]}]},"httpPath":"/custom-integration-settings"},{"label":"Create or update the account custom integration settings","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/custom/putcustomintegrationsettings","routeSlug":"/dash/openapi/custom/putcustomintegrationsettings","metadata":{"seo":{"title":"Create or update the account custom integration settings","description":"Create or update the account custom integration settings"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"putCustomIntegrationSettings","name":"Create or update the account custom integration settings","isWebhook":false,"pointer":"/paths/~1custom-integration-settings/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create or update the account custom integration settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CustomIntegrationSettingsPutRequest"}},"schemaId":"components/schemas/CustomIntegrationSettingsPutRequest","pointer":"/paths/~1custom-integration-settings/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/custom-integration-settings","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CustomIntegrationSettingsPutRequest"}},"responseCodes":["200","4XX"],"pointer":"/custom-integration-settings","href":"custom/putcustomintegrationsettings","openApiOperationId":"putCustomIntegrationSettings","summary":"Create or update the account custom integration settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/CustomIntegrationSettingsPutRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CustomIntegrationSettingsPutRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomIntegrationSettingsWithPermittedActions"}},"schemaId":"components/schemas/CustomIntegrationSettingsWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1custom-integration-settings/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CustomIntegrationSettingsWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomIntegrationSettingsWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom/putcustomintegrationsettings"}],"panels":[]}]},"httpPath":"/custom-integration-settings"},{"label":"Update the account custom integration settings","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/custom/patchcustomintegrationsettings","routeSlug":"/dash/openapi/custom/patchcustomintegrationsettings","metadata":{"seo":{"title":"Update the account custom integration settings","description":"Update the account custom integration settings"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchCustomIntegrationSettings","name":"Update the account custom integration settings","isWebhook":false,"pointer":"/paths/~1custom-integration-settings/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update the account custom integration settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CustomIntegrationSettingsPatchRequest"}},"schemaId":"components/schemas/CustomIntegrationSettingsPatchRequest","pointer":"/paths/~1custom-integration-settings/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/custom-integration-settings","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CustomIntegrationSettingsPatchRequest"}},"responseCodes":["200","4XX"],"pointer":"/custom-integration-settings","href":"custom/patchcustomintegrationsettings","openApiOperationId":"patchCustomIntegrationSettings","summary":"Update the account custom integration settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/CustomIntegrationSettingsPatchRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CustomIntegrationSettingsPatchRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomIntegrationSettingsWithPermittedActions"}},"schemaId":"components/schemas/CustomIntegrationSettingsWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1custom-integration-settings/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CustomIntegrationSettingsWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomIntegrationSettingsWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom/patchcustomintegrationsettings"}],"panels":[]}]},"httpPath":"/custom-integration-settings"},{"label":"Delete the account custom integration settings","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/custom/deletecustomintegrationsettings","routeSlug":"/dash/openapi/custom/deletecustomintegrationsettings","metadata":{"seo":{"title":"Delete the account custom integration settings","description":"Delete the account custom integration settings"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteCustomIntegrationSettings","name":"Delete the account custom integration settings","isWebhook":false,"pointer":"/paths/~1custom-integration-settings/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete the account custom integration settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/custom-integration-settings","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","4XX"],"pointer":"/custom-integration-settings","href":"custom/deletecustomintegrationsettings","openApiOperationId":"deleteCustomIntegrationSettings","summary":"Delete the account custom integration settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1custom-integration-settings/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom/deletecustomintegrationsettings"}],"panels":[]}]},"httpPath":"/custom-integration-settings"}],"content":{"contentType":"group","meta":{"name":"Custom"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Custom","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/custom-integration-settings","summary":"Get the account custom integration settings","prefix":{"name":"get","color":"get"},"badges":[],"link":"/custom/getcustomintegrationsettings","deprecated":false},{"title":"/custom-integration-settings","summary":"Create or update the account custom integration settings","prefix":{"name":"put","color":"put"},"badges":[],"link":"/custom/putcustomintegrationsettings","deprecated":false},{"title":"/custom-integration-settings","summary":"Update the account custom integration settings","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/custom/patchcustomintegrationsettings","deprecated":false},{"title":"/custom-integration-settings","summary":"Delete the account custom integration settings","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/custom/deletecustomintegrationsettings","deprecated":false}]}]}]}]}},{"type":"group","label":"External App","link":"/dash/openapi/external-app","routeSlug":"/dash/openapi/external-app","items":[{"label":"Create an external app user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/external-app/postexternalappuser","routeSlug":"/dash/openapi/external-app/postexternalappuser","metadata":{"seo":{"title":"Create an external app user","description":"Associate an external app user ID with the currently authenticated Dash user"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postExternalAppUser","name":"Create an external app user","isWebhook":false,"pointer":"/paths/~1external-app-users/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an external app user","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Associate an external app user ID with the currently authenticated Dash user\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExternalAppUserRequest"}},"schemaId":"components/schemas/ExternalAppUserRequest","pointer":"/paths/~1external-app-users/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/external-app-users","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ExternalAppUserRequest"}},"responseCodes":["204","4XX"],"pointer":"/external-app-users","href":"external-app/postexternalappuser","openApiOperationId":"postExternalAppUser","summary":"Create an external app user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/ExternalAppUserRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExternalAppUserRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1external-app-users/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/external-app/postexternalappuser"}],"panels":[]}]},"httpPath":"/external-app-users"},{"label":"Create an external app SSO token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/external-app/postexternalappssotokens","routeSlug":"/dash/openapi/external-app/postexternalappssotokens","metadata":{"seo":{"title":"Create an external app SSO token","description":"Create external app SSO token for the current user"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postExternalAppSsoTokens","name":"Create an external app SSO token","isWebhook":false,"pointer":"/paths/~1external-app-sso-tokens/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an external app SSO token","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create external app SSO token for the current user\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExternalAppSsoTokenRequest"}},"schemaId":"components/schemas/ExternalAppSsoTokenRequest","pointer":"/paths/~1external-app-sso-tokens/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/external-app-sso-tokens","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ExternalAppSsoTokenRequest"}},"responseCodes":["204","4XX"],"pointer":"/external-app-sso-tokens","href":"external-app/postexternalappssotokens","openApiOperationId":"postExternalAppSsoTokens","summary":"Create an external app SSO token"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/ExternalAppSsoTokenRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExternalAppSsoTokenRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1external-app-sso-tokens/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/external-app/postexternalappssotokens"}],"panels":[]}]},"httpPath":"/external-app-sso-tokens"},{"label":"Get all external app accounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/external-app/getexternalappaccounts","routeSlug":"/dash/openapi/external-app/getexternalappaccounts","metadata":{"seo":{"title":"Get all external app accounts","description":"Get all ExternalAppAccount resources ordered by ExternalAppAccount.externalAppAccountId"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getExternalAppAccounts","name":"Get all external app accounts","isWebhook":false,"pointer":"/paths/~1external-app-accounts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all external app accounts","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":"Get all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/external-app/getexternalappaccounts"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ExternalAppAccount"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources ordered by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/external-app/getexternalappaccounts"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ExternalAppAccount.externalAppAccountId"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/external-app-accounts","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","4XX"],"pointer":"/external-app-accounts","href":"external-app/getexternalappaccounts","openApiOperationId":"getExternalAppAccounts","summary":"Get all external app accounts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_36"}},"schemaId":"schema_36"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1external-app-accounts/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_36","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_36"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/external-app/getexternalappaccounts"}],"panels":[]}]},"httpPath":"/external-app-accounts"},{"label":"Create an external app account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/external-app/postexternalappaccount","routeSlug":"/dash/openapi/external-app/postexternalappaccount","metadata":{"seo":{"title":"Create an external app account","description":"Associate an external app account with the account of the currently authenticated Dash user"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postExternalAppAccount","name":"Create an external app account","isWebhook":false,"pointer":"/paths/~1external-app-accounts/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an external app account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Associate an external app account with the account of the currently authenticated Dash user\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExternalAppAccountRequest"}},"schemaId":"components/schemas/ExternalAppAccountRequest","pointer":"/paths/~1external-app-accounts/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/external-app-accounts","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ExternalAppAccountRequest"}},"responseCodes":["204","4XX"],"pointer":"/external-app-accounts","href":"external-app/postexternalappaccount","openApiOperationId":"postExternalAppAccount","summary":"Create an external app account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/ExternalAppAccountRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExternalAppAccountRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1external-app-accounts/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/external-app/postexternalappaccount"}],"panels":[]}]},"httpPath":"/external-app-accounts"}],"content":{"contentType":"group","meta":{"name":"External App"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"External App","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/external-app-users","summary":"Create an external app user","prefix":{"name":"post","color":"post"},"badges":[],"link":"/external-app/postexternalappuser","deprecated":false},{"title":"/external-app-sso-tokens","summary":"Create an external app SSO token","prefix":{"name":"post","color":"post"},"badges":[],"link":"/external-app/postexternalappssotokens","deprecated":false},{"title":"/external-app-accounts","summary":"Get all external app accounts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/external-app/getexternalappaccounts","deprecated":false},{"title":"/external-app-accounts","summary":"Create an external app account","prefix":{"name":"post","color":"post"},"badges":[],"link":"/external-app/postexternalappaccount","deprecated":false}]}]}]}]}},{"type":"group","label":"Shopify","link":"/dash/openapi/shopify","routeSlug":"/dash/openapi/shopify","items":[{"label":"Get Shopify installs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/shopify/getshopifyinstalls","routeSlug":"/dash/openapi/shopify/getshopifyinstalls","metadata":{"seo":{"title":"Get Shopify installs","description":"Get the current Shopify install states for the account of the currently authenticated Dash user."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getShopifyInstalls","name":"Get Shopify installs","isWebhook":false,"pointer":"/paths/~1shopify-installs/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Shopify installs","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get the current Shopify install states for the account of the currently authenticated Dash user.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/shopify-installs","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","4XX"],"pointer":"/shopify-installs","href":"shopify/getshopifyinstalls","openApiOperationId":"getShopifyInstalls","summary":"Get Shopify installs"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_37"}},"schemaId":"schema_37"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1shopify-installs/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_37","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_37"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shopify/getshopifyinstalls"}],"panels":[]}]},"httpPath":"/shopify-installs"},{"label":"Request a Shopify install link","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/shopify/postshopifyinstall","routeSlug":"/dash/openapi/shopify/postshopifyinstall","metadata":{"seo":{"title":"Request a Shopify install link","description":"Request a Shopify install link for the account of the currently authenticated Dash user."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postShopifyInstall","name":"Request a Shopify install link","isWebhook":false,"pointer":"/paths/~1shopify-installs/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Request a Shopify install link","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Request a Shopify install link for the account of the currently authenticated Dash user.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ShopifyInstallRequest"}},"schemaId":"components/schemas/ShopifyInstallRequest","pointer":"/paths/~1shopify-installs/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/shopify-installs","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ShopifyInstallRequest"}},"responseCodes":["200","4XX"],"pointer":"/shopify-installs","href":"shopify/postshopifyinstall","openApiOperationId":"postShopifyInstall","summary":"Request a Shopify install link"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/ShopifyInstallRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ShopifyInstallRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ShopifyInstallWithPermittedActions"}},"schemaId":"components/schemas/ShopifyInstallWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1shopify-installs/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ShopifyInstallWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ShopifyInstallWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shopify/postshopifyinstall"}],"panels":[]}]},"httpPath":"/shopify-installs"},{"label":"Update a Shopify install","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/shopify/patchshopifyinstall","routeSlug":"/dash/openapi/shopify/patchshopifyinstall","metadata":{"seo":{"title":"Update a Shopify install","description":"Update a Shopify install for the account of the currently authenticated Dash user."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchShopifyInstall","name":"Update a Shopify install","isWebhook":false,"pointer":"/paths/~1shopify-installs~1{shopifyDomain}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a Shopify install","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update a Shopify install for the account of the currently authenticated Dash user.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"shopifyDomain","in":"path","schemaId":"schema_25","description":"The Shopify domain that uniquely identifies the install","required":true}],"pointer":"/paths/~1shopify-installs~1{shopifyDomain}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ShopifyInstallPatchRequest"}},"schemaId":"components/schemas/ShopifyInstallPatchRequest","pointer":"/paths/~1shopify-installs~1{shopifyDomain}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/shopify-installs/{shopifyDomain}","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"shopifyDomain","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ShopifyInstallPatchRequest"}},"responseCodes":["200","4XX"],"pointer":"/shopify-installs/{shopifyDomain}","href":"shopify/patchshopifyinstall","openApiOperationId":"patchShopifyInstall","summary":"Update a Shopify install"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/ShopifyInstallPatchRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ShopifyInstallPatchRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ShopifyInstallWithPermittedActions"}},"schemaId":"components/schemas/ShopifyInstallWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1shopify-installs~1{shopifyDomain}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ShopifyInstallWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ShopifyInstallWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shopify/patchshopifyinstall"}],"panels":[]}]},"httpPath":"/shopify-installs/{shopifyDomain}"},{"label":"Get the status of exporting to Shopify","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/shopify/getshopifyexportjob","routeSlug":"/dash/openapi/shopify/getshopifyexportjob","metadata":{"seo":{"title":"Get the status of exporting to Shopify","description":"Get the status and eventual result of a ShopifyExportJob"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getShopifyExportJob","name":"Get the status of exporting to Shopify","isWebhook":false,"pointer":"/paths/~1shopify-export-jobs~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get the status of exporting to Shopify","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":"Get the status and eventual result of a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/shopify/postshopifyexportjob"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ShopifyExportJob"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/shopify/postshopifyexportjob"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ShopifyExportJob"},"children":[]}]}]}]}],"required":true}],"pointer":"/paths/~1shopify-export-jobs~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/shopify-export-jobs/{id}","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","4XX"],"pointer":"/shopify-export-jobs/{id}","href":"shopify/getshopifyexportjob","openApiOperationId":"getShopifyExportJob","summary":"Get the status of exporting to Shopify"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ShopifyExportJobWithPermittedActions"}},"schemaId":"components/schemas/ShopifyExportJobWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1shopify-export-jobs~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ShopifyExportJobWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ShopifyExportJobWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shopify/getshopifyexportjob"}],"panels":[]}]},"httpPath":"/shopify-export-jobs/{id}"},{"label":"Update the status of exporting to Shopify","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/shopify/patchshopifyexportjob","routeSlug":"/dash/openapi/shopify/patchshopifyexportjob","metadata":{"seo":{"title":"Update the status of exporting to Shopify","description":"Update a ShopifyExportJob. Primarily used to stop a job."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchShopifyExportJob","name":"Update the status of exporting to Shopify","isWebhook":false,"pointer":"/paths/~1shopify-export-jobs~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update the status of exporting to Shopify","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":"Update a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/shopify/postshopifyexportjob"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ShopifyExportJob"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Primarily used to stop a job."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/shopify/postshopifyexportjob"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ShopifyExportJob"},"children":[]}]}]}]}],"required":true}],"pointer":"/paths/~1shopify-export-jobs~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/JobPatchRequest"}},"schemaId":"components/schemas/JobPatchRequest","pointer":"/paths/~1shopify-export-jobs~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/shopify-export-jobs/{id}","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/JobPatchRequest"}},"responseCodes":["200","4XX"],"pointer":"/shopify-export-jobs/{id}","href":"shopify/patchshopifyexportjob","openApiOperationId":"patchShopifyExportJob","summary":"Update the status of exporting to Shopify"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/JobPatchRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/JobPatchRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ShopifyExportJobWithPermittedActions"}},"schemaId":"components/schemas/ShopifyExportJobWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1shopify-export-jobs~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ShopifyExportJobWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ShopifyExportJobWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shopify/patchshopifyexportjob"}],"panels":[]}]},"httpPath":"/shopify-export-jobs/{id}"},{"label":"Delete a Shopify export","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/shopify/deleteshopifyexportjob","routeSlug":"/dash/openapi/shopify/deleteshopifyexportjob","metadata":{"seo":{"title":"Delete a Shopify export","description":"Deletes a ShopifyExportJob"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteShopifyExportJob","name":"Delete a Shopify export","isWebhook":false,"pointer":"/paths/~1shopify-export-jobs~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a Shopify export","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 "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/shopify/postshopifyexportjob"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ShopifyExportJob"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/shopify/postshopifyexportjob"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ShopifyExportJob"},"children":[]}]}]}]}],"required":true}],"pointer":"/paths/~1shopify-export-jobs~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/shopify-export-jobs/{id}","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","4XX"],"pointer":"/shopify-export-jobs/{id}","href":"shopify/deleteshopifyexportjob","openApiOperationId":"deleteShopifyExportJob","summary":"Delete a Shopify export"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1shopify-export-jobs~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shopify/deleteshopifyexportjob"}],"panels":[]}]},"httpPath":"/shopify-export-jobs/{id}"},{"label":"Export images to products in Shopify","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/shopify/postshopifyexportjob","routeSlug":"/dash/openapi/shopify/postshopifyexportjob","metadata":{"seo":{"title":"Export images to products in Shopify","description":"Create a Shopify export job to upload multiple assets from Dash into your Shopify account. The uploaded assets can be associated with products and their position on the product listing can be specified. Existing Shopify images can also be detached from specific products or reordered."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postShopifyExportJob","name":"Export images to products in Shopify","isWebhook":false,"pointer":"/paths/~1shopify-export-jobs/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Export images to products in Shopify","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a Shopify export job to upload multiple assets from Dash into your Shopify account.\nThe uploaded assets can be associated with products and their position on the product listing can be specified.\nExisting Shopify images can also be detached from specific products or reordered.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ShopifyExportRequest"}},"schemaId":"components/schemas/ShopifyExportRequest","pointer":"/paths/~1shopify-export-jobs/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/shopify-export-jobs","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ShopifyExportRequest"}},"responseCodes":["200","4XX"],"pointer":"/shopify-export-jobs","href":"shopify/postshopifyexportjob","openApiOperationId":"postShopifyExportJob","summary":"Export images to products in Shopify"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/ShopifyExportRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ShopifyExportRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ShopifyExportJobWithPermittedActions"}},"schemaId":"components/schemas/ShopifyExportJobWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1shopify-export-jobs/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ShopifyExportJobWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ShopifyExportJobWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shopify/postshopifyexportjob"}],"panels":[]}]},"httpPath":"/shopify-export-jobs"},{"label":"Get the current user's shopify export jobs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/shopify/getcurrentusershopifyexportjobs","routeSlug":"/dash/openapi/shopify/getcurrentusershopifyexportjobs","metadata":{"seo":{"title":"Get the current user's shopify export jobs","description":"Get the status and eventual result of all ShopifyExportJobs for the current user"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCurrentUserShopifyExportJobs","name":"Get the current user's shopify export jobs","isWebhook":false,"pointer":"/paths/~1current-user-shopify-export-jobs/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get the current user's shopify export jobs","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":"Get the status and eventual result of all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/shopify/postshopifyexportjob"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ShopifyExportJob"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"s for the current user"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/current-user-shopify-export-jobs","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","4XX"],"pointer":"/current-user-shopify-export-jobs","href":"shopify/getcurrentusershopifyexportjobs","openApiOperationId":"getCurrentUserShopifyExportJobs","summary":"Get the current user's shopify export jobs"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_38"}},"schemaId":"schema_38"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1current-user-shopify-export-jobs/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_38","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_38"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shopify/getcurrentusershopifyexportjobs"}],"panels":[]}]},"httpPath":"/current-user-shopify-export-jobs"},{"label":"Send product images to Shopify","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/shopify/postcreateshopifyproductimagebatchjob","routeSlug":"/dash/openapi/shopify/postcreateshopifyproductimagebatchjob","metadata":{"seo":{"title":"Send product images to Shopify","description":"See AssetDownloadBatchJob for an idea of how to use this endpoint"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postCreateShopifyProductImageBatchJob","name":"Send product images to Shopify","isWebhook":false,"pointer":"/paths/~1create-shopify-product-image-batch-jobs/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Send product images to Shopify","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":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/postassetdownloadbatchjob"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetDownloadBatchJob"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for an idea of how to use this endpoint"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateShopifyProductImageBatchRequest"}},"schemaId":"components/schemas/CreateShopifyProductImageBatchRequest","pointer":"/paths/~1create-shopify-product-image-batch-jobs/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/create-shopify-product-image-batch-jobs","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateShopifyProductImageBatchRequest"}},"responseCodes":["200","4XX"],"pointer":"/create-shopify-product-image-batch-jobs","href":"shopify/postcreateshopifyproductimagebatchjob","openApiOperationId":"postCreateShopifyProductImageBatchJob","summary":"Send product images to Shopify"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/CreateShopifyProductImageBatchRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateShopifyProductImageBatchRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NoResultJob"}},"schemaId":"components/schemas/NoResultJob"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1create-shopify-product-image-batch-jobs/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/NoResultJob","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NoResultJob"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shopify/postcreateshopifyproductimagebatchjob"}],"panels":[]}]},"httpPath":"/create-shopify-product-image-batch-jobs"},{"label":"Send images to Shopify","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/shopify/postcreateshopifyimagebatchjob","routeSlug":"/dash/openapi/shopify/postcreateshopifyimagebatchjob","metadata":{"seo":{"title":"Send images to Shopify","description":"See AssetDownloadBatchJob for an idea of how to use this endpoint"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postCreateShopifyImageBatchJob","name":"Send images to Shopify","isWebhook":false,"pointer":"/paths/~1create-shopify-image-batch-jobs/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Send images to Shopify","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":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/postassetdownloadbatchjob"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetDownloadBatchJob"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for an idea of how to use this endpoint"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateShopifyImageBatchRequest"}},"schemaId":"components/schemas/CreateShopifyImageBatchRequest","pointer":"/paths/~1create-shopify-image-batch-jobs/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/create-shopify-image-batch-jobs","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateShopifyImageBatchRequest"}},"responseCodes":["200","4XX"],"pointer":"/create-shopify-image-batch-jobs","href":"shopify/postcreateshopifyimagebatchjob","openApiOperationId":"postCreateShopifyImageBatchJob","summary":"Send images to Shopify"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/CreateShopifyImageBatchRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateShopifyImageBatchRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NoResultJob"}},"schemaId":"components/schemas/NoResultJob"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1create-shopify-image-batch-jobs/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/NoResultJob","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NoResultJob"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shopify/postcreateshopifyimagebatchjob"}],"panels":[]}]},"httpPath":"/create-shopify-image-batch-jobs"},{"label":"Sync products from Shopify","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/shopify/postshopifyproductsyncjob","routeSlug":"/dash/openapi/shopify/postshopifyproductsyncjob","metadata":{"seo":{"title":"Sync products from Shopify","description":"Kicks off a job that syncs product data (products, variant options, option values and variants) from the account's configured Shopify connection. Rejected with 409 if a sync is already in progress for the account. Poll the returned job by id to track progress."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postShopifyProductSyncJob","name":"Sync products from Shopify","isWebhook":false,"pointer":"/paths/~1shopify-product-sync-jobs/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sync products from Shopify","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Kicks off a job that syncs product data (products, variant options, option values and variants)\nfrom the account's configured Shopify connection. Rejected with 409 if a sync is already in\nprogress for the account. Poll the returned job by id to track progress.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/shopify-product-sync-jobs","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","4XX"],"pointer":"/shopify-product-sync-jobs","href":"shopify/postshopifyproductsyncjob","openApiOperationId":"postShopifyProductSyncJob","summary":"Sync products from Shopify"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NoResultJob"}},"schemaId":"components/schemas/NoResultJob"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1shopify-product-sync-jobs/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/NoResultJob","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NoResultJob"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shopify/postshopifyproductsyncjob"}],"panels":[]}]},"httpPath":"/shopify-product-sync-jobs"},{"label":"Get the status of a Shopify product sync job","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/shopify/getshopifyproductsyncjob","routeSlug":"/dash/openapi/shopify/getshopifyproductsyncjob","metadata":{"seo":{"title":"Get the status of a Shopify product sync job","description":"Get the status of a Shopify product sync job"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getShopifyProductSyncJob","name":"Get the status of a Shopify product sync job","isWebhook":false,"pointer":"/paths/~1shopify-product-sync-jobs~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get the status of a Shopify product sync job","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":"Get the status of a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/shopify/postshopifyproductsyncjob"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Shopify product sync job"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_25","required":true}],"pointer":"/paths/~1shopify-product-sync-jobs~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/shopify-product-sync-jobs/{id}","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","4XX"],"pointer":"/shopify-product-sync-jobs/{id}","href":"shopify/getshopifyproductsyncjob","openApiOperationId":"getShopifyProductSyncJob","summary":"Get the status of a Shopify product sync job"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NoResultJob"}},"schemaId":"components/schemas/NoResultJob"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1shopify-product-sync-jobs~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/NoResultJob","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NoResultJob"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shopify/getshopifyproductsyncjob"}],"panels":[]}]},"httpPath":"/shopify-product-sync-jobs/{id}"},{"label":"Get the current Shopify product sync status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/shopify/getshopifyproductsyncstatus","routeSlug":"/dash/openapi/shopify/getshopifyproductsyncstatus","metadata":{"seo":{"title":"Get the current Shopify product sync status","description":"Returns whether a Shopify product sync is currently in progress for the account and when a sync last completed (if ever)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getShopifyProductSyncStatus","name":"Get the current Shopify product sync status","isWebhook":false,"pointer":"/paths/~1shopify-product-sync-status/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get the current Shopify product sync status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns whether a Shopify product sync is currently in progress for the account\nand when a sync last completed (if ever)\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/shopify-product-sync-status","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","4XX"],"pointer":"/shopify-product-sync-status","href":"shopify/getshopifyproductsyncstatus","openApiOperationId":"getShopifyProductSyncStatus","summary":"Get the current Shopify product sync status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ShopifyProductSyncStatusWithPermittedActions"}},"schemaId":"components/schemas/ShopifyProductSyncStatusWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1shopify-product-sync-status/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ShopifyProductSyncStatusWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ShopifyProductSyncStatusWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shopify/getshopifyproductsyncstatus"}],"panels":[]}]},"httpPath":"/shopify-product-sync-status"},{"label":"Get the account Shopify product sync settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/shopify/getshopifyproductsyncsettings","routeSlug":"/dash/openapi/shopify/getshopifyproductsyncsettings","metadata":{"seo":{"title":"Get the account Shopify product sync settings","description":"Returns which Shopify connection is configured to be used for product syncs (an empty list if none)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getShopifyProductSyncSettings","name":"Get the account Shopify product sync settings","isWebhook":false,"pointer":"/paths/~1shopify-product-sync-settings/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get the account Shopify product sync settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns which Shopify connection is configured to be used for product syncs (an empty list if none)\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/shopify-product-sync-settings","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","4XX"],"pointer":"/shopify-product-sync-settings","href":"shopify/getshopifyproductsyncsettings","openApiOperationId":"getShopifyProductSyncSettings","summary":"Get the account Shopify product sync settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ShopifyProductSyncSettingsWithPermittedActions"}},"schemaId":"components/schemas/ShopifyProductSyncSettingsWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1shopify-product-sync-settings/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ShopifyProductSyncSettingsWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ShopifyProductSyncSettingsWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shopify/getshopifyproductsyncsettings"}],"panels":[]}]},"httpPath":"/shopify-product-sync-settings"},{"label":"Set the Shopify connection used for product syncs","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/shopify/putshopifyproductsyncsettings","routeSlug":"/dash/openapi/shopify/putshopifyproductsyncsettings","metadata":{"seo":{"title":"Set the Shopify connection used for product syncs","description":"Sets the full list of Shopify connections used for product syncs. Currently only a list containing a single connection is supported anything else is rejected with 422. Setting a connection kicks off a product sync. If a sync is already in progress it is allowed to finish, after which a sync for the newly chosen connection runs."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"putShopifyProductSyncSettings","name":"Set the Shopify connection used for product syncs","isWebhook":false,"pointer":"/paths/~1shopify-product-sync-settings/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Set the Shopify connection used for product syncs","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Sets the full list of Shopify connections used for product syncs. Currently only a list containing a single \nconnection is supported anything else is rejected with 422. Setting a connection kicks\noff a product sync. If a sync is already in progress it is allowed to finish, after which a sync\nfor the newly chosen connection runs.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ShopifyProductSyncSettingsRequest"}},"schemaId":"components/schemas/ShopifyProductSyncSettingsRequest","pointer":"/paths/~1shopify-product-sync-settings/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/shopify-product-sync-settings","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ShopifyProductSyncSettingsRequest"}},"responseCodes":["200","4XX"],"pointer":"/shopify-product-sync-settings","href":"shopify/putshopifyproductsyncsettings","openApiOperationId":"putShopifyProductSyncSettings","summary":"Set the Shopify connection used for product syncs"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/ShopifyProductSyncSettingsRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ShopifyProductSyncSettingsRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ShopifyProductSyncSettingsWithPermittedActions"}},"schemaId":"components/schemas/ShopifyProductSyncSettingsWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1shopify-product-sync-settings/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ShopifyProductSyncSettingsWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ShopifyProductSyncSettingsWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shopify/putshopifyproductsyncsettings"}],"panels":[]}]},"httpPath":"/shopify-product-sync-settings"},{"label":"Get a Shopify connection","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/shopify/getshopifyconnection","routeSlug":"/dash/openapi/shopify/getshopifyconnection","metadata":{"seo":{"title":"Get a Shopify connection","description":"Get details about a particular connection to Shopify"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getShopifyConnection","name":"Get a Shopify connection","isWebhook":false,"pointer":"/paths/~1shopify-connections~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a Shopify connection","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get details about a particular connection to Shopify\n"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_25","description":"The shop name that uniquely identifies a Shopify connection","required":true}],"pointer":"/paths/~1shopify-connections~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/shopify-connections/{id}","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","4XX"],"pointer":"/shopify-connections/{id}","href":"shopify/getshopifyconnection","openApiOperationId":"getShopifyConnection","summary":"Get a Shopify connection"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ShopifyConnectionWithPermittedActions"}},"schemaId":"components/schemas/ShopifyConnectionWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1shopify-connections~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ShopifyConnectionWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ShopifyConnectionWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shopify/getshopifyconnection"}],"panels":[]}]},"httpPath":"/shopify-connections/{id}"},{"label":"Callback required to install Dash with Shopify","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/shopify/getshopifycallback","routeSlug":"/dash/openapi/shopify/getshopifycallback","metadata":{"seo":{"title":"Callback required to install Dash with Shopify","description":"This is quite an internal endpoint and is only really in the API due to needing to be on the dash.app domain."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getShopifyCallback","name":"Callback required to install Dash with Shopify","isWebhook":false,"pointer":"/paths/~1shopify-callback/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Callback required to install Dash with Shopify","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This is quite an internal endpoint and is only really in the API due to needing to be on the dash.app domain.\n"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"shop","in":"query","schemaId":"schema_25","description":"The shop name that uniquely identifies a Shopify connection","required":true},{"name":"hmac","in":"query","schemaId":"schema_25","description":"A hash of all other parameters created by using the Shopify secret key as the key","required":true},{"name":"session","in":"query","schemaId":"schema_25","description":"The current session"},{"name":"timestamp","in":"query","schemaId":"schema_25"},{"name":"locale","in":"query","schemaId":"schema_25"},{"name":"host","in":"query","schemaId":"schema_25"},{"name":"embedded","in":"query","schemaId":"schema_25"}],"pointer":"/paths/~1shopify-callback/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/shopify-callback","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[{"name":"shop","in":"query","required":true,"schemaId":"schema_25"},{"name":"hmac","in":"query","required":true,"schemaId":"schema_25"},{"name":"session","in":"query","required":false,"schemaId":"schema_25"},{"name":"timestamp","in":"query","required":false,"schemaId":"schema_25"},{"name":"locale","in":"query","required":false,"schemaId":"schema_25"},{"name":"host","in":"query","required":false,"schemaId":"schema_25"},{"name":"embedded","in":"query","required":false,"schemaId":"schema_25"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["302","4XX"],"pointer":"/shopify-callback","href":"shopify/getshopifycallback","openApiOperationId":"getShopifyCallback","summary":"Callback required to install Dash with Shopify"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"302","description":"Success"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1shopify-callback/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"302"},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shopify/getshopifycallback"}],"panels":[]}]},"httpPath":"/shopify-callback"},{"label":"Search for shopify products","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/shopify/postproductsearches","routeSlug":"/dash/openapi/shopify/postproductsearches","metadata":{"seo":{"title":"Search for shopify products","description":"Search for products from a given Shopify store"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postProductSearches","name":"Search for shopify products","isWebhook":false,"pointer":"/paths/~1shopify-product-searches/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search for shopify products","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Search for products from a given Shopify store\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ShopifyProductSearchRequest"}},"schemaId":"components/schemas/ShopifyProductSearchRequest","pointer":"/paths/~1shopify-product-searches/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/shopify-product-searches","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ShopifyProductSearchRequest"}},"responseCodes":["200","4XX"],"pointer":"/shopify-product-searches","href":"shopify/postproductsearches","openApiOperationId":"postProductSearches","summary":"Search for shopify products"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/ShopifyProductSearchRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ShopifyProductSearchRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ShopifyProductSearch"}},"schemaId":"components/schemas/ShopifyProductSearch"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1shopify-product-searches/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ShopifyProductSearch","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ShopifyProductSearch"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shopify/postproductsearches"}],"panels":[]}]},"httpPath":"/shopify-product-searches"},{"label":"Search for Shopify products by Dash product IDs","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/shopify/postshopifyproductidsearches","routeSlug":"/dash/openapi/shopify/postshopifyproductidsearches","metadata":{"seo":{"title":"Search for Shopify products by Dash product IDs","description":"Resolves Dash products to their stored Shopify product IDs and searches the given Shopify store for those products."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postShopifyProductIdSearches","name":"Search for Shopify products by Dash product IDs","isWebhook":false,"pointer":"/paths/~1shopify-product-id-searches/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search for Shopify products by Dash product IDs","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Resolves Dash products to their stored Shopify product IDs and searches the given Shopify store for those products.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ShopifyProductIdSearchRequest"}},"schemaId":"components/schemas/ShopifyProductIdSearchRequest","pointer":"/paths/~1shopify-product-id-searches/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/shopify-product-id-searches","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ShopifyProductIdSearchRequest"}},"responseCodes":["200","4XX"],"pointer":"/shopify-product-id-searches","href":"shopify/postshopifyproductidsearches","openApiOperationId":"postShopifyProductIdSearches","summary":"Search for Shopify products by Dash product IDs"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/ShopifyProductIdSearchRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ShopifyProductIdSearchRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ShopifyProductIdSearch"}},"schemaId":"components/schemas/ShopifyProductIdSearch"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1shopify-product-id-searches/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ShopifyProductIdSearch","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ShopifyProductIdSearch"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shopify/postshopifyproductidsearches"}],"panels":[]}]},"httpPath":"/shopify-product-id-searches"},{"label":"Alter Shopify store","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/shopify/postadminaltershopifystore","routeSlug":"/dash/openapi/shopify/postadminaltershopifystore","metadata":{"seo":{"title":"Alter Shopify store","description":"Admin only alter of Shopify store"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postAdminAlterShopifyStore","name":"Alter Shopify store","isWebhook":false,"pointer":"/paths/~1admin~1alter-shopify-store/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Alter Shopify store","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Admin only alter of Shopify store"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AlterShopifyStoreRequest"}},"schemaId":"components/schemas/AlterShopifyStoreRequest","pointer":"/paths/~1admin~1alter-shopify-store/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/admin/alter-shopify-store","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AlterShopifyStoreRequest"}},"responseCodes":["204","4XX"],"pointer":"/admin/alter-shopify-store","href":"shopify/postadminaltershopifystore","openApiOperationId":"postAdminAlterShopifyStore","summary":"Alter Shopify store"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/AlterShopifyStoreRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AlterShopifyStoreRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1admin~1alter-shopify-store/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shopify/postadminaltershopifystore"}],"panels":[]}]},"httpPath":"/admin/alter-shopify-store"}],"content":{"contentType":"group","meta":{"name":"Shopify"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Shopify","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Coming soon; "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"mailto:help@dash.app"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contact us"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if you need access to this API endpoint."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/shopify-installs","summary":"Get Shopify installs","prefix":{"name":"get","color":"get"},"badges":[],"link":"/shopify/getshopifyinstalls","deprecated":false},{"title":"/shopify-installs","summary":"Request a Shopify install link","prefix":{"name":"post","color":"post"},"badges":[],"link":"/shopify/postshopifyinstall","deprecated":false},{"title":"/shopify-installs/{shopifyDomain}","summary":"Update a Shopify install","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/shopify/patchshopifyinstall","deprecated":false},{"title":"/shopify-export-jobs/{id}","summary":"Get the status of exporting to Shopify","prefix":{"name":"get","color":"get"},"badges":[],"link":"/shopify/getshopifyexportjob","deprecated":false},{"title":"/shopify-export-jobs/{id}","summary":"Update the status of exporting to Shopify","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/shopify/patchshopifyexportjob","deprecated":false},{"title":"/shopify-export-jobs/{id}","summary":"Delete a Shopify export","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/shopify/deleteshopifyexportjob","deprecated":false},{"title":"/shopify-export-jobs","summary":"Export images to products in Shopify","prefix":{"name":"post","color":"post"},"badges":[],"link":"/shopify/postshopifyexportjob","deprecated":false},{"title":"/current-user-shopify-export-jobs","summary":"Get the current user's shopify export jobs","prefix":{"name":"get","color":"get"},"badges":[],"link":"/shopify/getcurrentusershopifyexportjobs","deprecated":false},{"title":"/create-shopify-product-image-batch-jobs","summary":"Send product images to Shopify","prefix":{"name":"post","color":"post"},"badges":[],"link":"/shopify/postcreateshopifyproductimagebatchjob","deprecated":false},{"title":"/create-shopify-image-batch-jobs","summary":"Send images to Shopify","prefix":{"name":"post","color":"post"},"badges":[],"link":"/shopify/postcreateshopifyimagebatchjob","deprecated":false},{"title":"/shopify-product-sync-jobs","summary":"Sync products from Shopify","prefix":{"name":"post","color":"post"},"badges":[],"link":"/shopify/postshopifyproductsyncjob","deprecated":false},{"title":"/shopify-product-sync-jobs/{id}","summary":"Get the status of a Shopify product sync job","prefix":{"name":"get","color":"get"},"badges":[],"link":"/shopify/getshopifyproductsyncjob","deprecated":false},{"title":"/shopify-product-sync-status","summary":"Get the current Shopify product sync status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/shopify/getshopifyproductsyncstatus","deprecated":false},{"title":"/shopify-product-sync-settings","summary":"Get the account Shopify product sync settings","prefix":{"name":"get","color":"get"},"badges":[],"link":"/shopify/getshopifyproductsyncsettings","deprecated":false},{"title":"/shopify-product-sync-settings","summary":"Set the Shopify connection used for product syncs","prefix":{"name":"put","color":"put"},"badges":[],"link":"/shopify/putshopifyproductsyncsettings","deprecated":false},{"title":"/shopify-connections/{id}","summary":"Get a Shopify connection","prefix":{"name":"get","color":"get"},"badges":[],"link":"/shopify/getshopifyconnection","deprecated":false},{"title":"/shopify-callback","summary":"Callback required to install Dash with Shopify","prefix":{"name":"get","color":"get"},"badges":[],"link":"/shopify/getshopifycallback","deprecated":false},{"title":"/shopify-product-searches","summary":"Search for shopify products","prefix":{"name":"post","color":"post"},"badges":[],"link":"/shopify/postproductsearches","deprecated":false},{"title":"/shopify-product-id-searches","summary":"Search for Shopify products by Dash product IDs","prefix":{"name":"post","color":"post"},"badges":[],"link":"/shopify/postshopifyproductidsearches","deprecated":false},{"title":"/admin/alter-shopify-store","summary":"Alter Shopify store","prefix":{"name":"post","color":"post"},"badges":[],"link":"/shopify/postadminaltershopifystore","deprecated":false}]}]}]}]}},{"type":"group","label":"WordPress","link":"/dash/openapi/wordpress","routeSlug":"/dash/openapi/wordpress","items":[{"label":"Get the account WordPress settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/wordpress/getwordpresssettings","routeSlug":"/dash/openapi/wordpress/getwordpresssettings","metadata":{"seo":{"title":"Get the account WordPress settings","description":"Get the account WordPress settings"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getWordPressSettings","name":"Get the account WordPress settings","isWebhook":false,"pointer":"/paths/~1wordpress-settings/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get the account WordPress settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/wordpress-settings","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","4XX"],"pointer":"/wordpress-settings","href":"wordpress/getwordpresssettings","openApiOperationId":"getWordPressSettings","summary":"Get the account WordPress settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WordPressSettingsWithPermittedActions"}},"schemaId":"components/schemas/WordPressSettingsWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1wordpress-settings/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/WordPressSettingsWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WordPressSettingsWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/wordpress/getwordpresssettings"}],"panels":[]}]},"httpPath":"/wordpress-settings"},{"label":"Create or update the account WordPress settings","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/wordpress/putwordpresssettings","routeSlug":"/dash/openapi/wordpress/putwordpresssettings","metadata":{"seo":{"title":"Create or update the account WordPress settings","description":"Create or update the account WordPress settings"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"putWordPressSettings","name":"Create or update the account WordPress settings","isWebhook":false,"pointer":"/paths/~1wordpress-settings/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create or update the account WordPress settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WordPressSettingsPutRequest"}},"schemaId":"components/schemas/WordPressSettingsPutRequest","pointer":"/paths/~1wordpress-settings/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/wordpress-settings","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/WordPressSettingsPutRequest"}},"responseCodes":["200","4XX"],"pointer":"/wordpress-settings","href":"wordpress/putwordpresssettings","openApiOperationId":"putWordPressSettings","summary":"Create or update the account WordPress settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/WordPressSettingsPutRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WordPressSettingsPutRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WordPressSettingsWithPermittedActions"}},"schemaId":"components/schemas/WordPressSettingsWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1wordpress-settings/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/WordPressSettingsWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WordPressSettingsWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/wordpress/putwordpresssettings"}],"panels":[]}]},"httpPath":"/wordpress-settings"},{"label":"Update the account WordPress settings","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/wordpress/patchwordpresssettings","routeSlug":"/dash/openapi/wordpress/patchwordpresssettings","metadata":{"seo":{"title":"Update the account WordPress settings","description":"Update the account WordPress settings"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchWordPressSettings","name":"Update the account WordPress settings","isWebhook":false,"pointer":"/paths/~1wordpress-settings/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update the account WordPress settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WordPressSettingsPatchRequest"}},"schemaId":"components/schemas/WordPressSettingsPatchRequest","pointer":"/paths/~1wordpress-settings/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/wordpress-settings","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/WordPressSettingsPatchRequest"}},"responseCodes":["200","4XX"],"pointer":"/wordpress-settings","href":"wordpress/patchwordpresssettings","openApiOperationId":"patchWordPressSettings","summary":"Update the account WordPress settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/WordPressSettingsPatchRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WordPressSettingsPatchRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WordPressSettingsWithPermittedActions"}},"schemaId":"components/schemas/WordPressSettingsWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1wordpress-settings/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/WordPressSettingsWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WordPressSettingsWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/wordpress/patchwordpresssettings"}],"panels":[]}]},"httpPath":"/wordpress-settings"},{"label":"Delete the account WordPress settings","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/wordpress/deletewordpresssettings","routeSlug":"/dash/openapi/wordpress/deletewordpresssettings","metadata":{"seo":{"title":"Delete the account WordPress settings","description":"Delete the account WordPress settings"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteWordPressSettings","name":"Delete the account WordPress settings","isWebhook":false,"pointer":"/paths/~1wordpress-settings/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete the account WordPress settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/wordpress-settings","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","4XX"],"pointer":"/wordpress-settings","href":"wordpress/deletewordpresssettings","openApiOperationId":"deleteWordPressSettings","summary":"Delete the account WordPress settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1wordpress-settings/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/wordpress/deletewordpresssettings"}],"panels":[]}]},"httpPath":"/wordpress-settings"}],"content":{"contentType":"group","meta":{"name":"WordPress"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"WordPress","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/wordpress-settings","summary":"Get the account WordPress settings","prefix":{"name":"get","color":"get"},"badges":[],"link":"/wordpress/getwordpresssettings","deprecated":false},{"title":"/wordpress-settings","summary":"Create or update the account WordPress settings","prefix":{"name":"put","color":"put"},"badges":[],"link":"/wordpress/putwordpresssettings","deprecated":false},{"title":"/wordpress-settings","summary":"Update the account WordPress settings","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/wordpress/patchwordpresssettings","deprecated":false},{"title":"/wordpress-settings","summary":"Delete the account WordPress settings","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/wordpress/deletewordpresssettings","deprecated":false}]}]}]}]}},{"type":"separator","label":"Portals","content":null},{"type":"group","label":"Portals","link":"/dash/openapi/portals","routeSlug":"/dash/openapi/portals","items":[{"label":"Create a portal","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/portals/postportal","routeSlug":"/dash/openapi/portals/postportal","metadata":{"seo":{"title":"Create a portal","description":"Create a new Portal, allowing public access to specified folders to anyone who has one of the Portal.slugs."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postPortal","name":"Create a portal","isWebhook":false,"pointer":"/paths/~1portals/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a portal","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":"Create a new "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Portals"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Portal"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", allowing public access to specified folders to anyone who has one of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Portal.slugs"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PortalRequest"}},"schemaId":"components/schemas/PortalRequest","pointer":"/paths/~1portals/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/portals","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PortalRequest"}},"responseCodes":["200","4XX"],"pointer":"/portals","href":"portals/postportal","openApiOperationId":"postPortal","summary":"Create a portal"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/PortalRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PortalRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PortalWithPermittedActions"}},"schemaId":"components/schemas/PortalWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1portals/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PortalWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PortalWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/portals/postportal"}],"panels":[]}]},"httpPath":"/portals"},{"label":"Get a portal","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/portals/getportal","routeSlug":"/dash/openapi/portals/getportal","metadata":{"seo":{"title":"Get a portal","description":"Get a Portal"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPortal","name":"Get a portal","isWebhook":false,"pointer":"/paths/~1portals~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a portal","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":"Get a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Portals"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Portal"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Portals"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Portal"},"children":[]}]}]}]}],"required":true}],"pointer":"/paths/~1portals~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/portals/{id}","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","4XX"],"pointer":"/portals/{id}","href":"portals/getportal","openApiOperationId":"getPortal","summary":"Get a portal"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PortalWithPermittedActions"}},"schemaId":"components/schemas/PortalWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1portals~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PortalWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PortalWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/portals/getportal"}],"panels":[]}]},"httpPath":"/portals/{id}"},{"label":"Update a portal","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/portals/patchportal","routeSlug":"/dash/openapi/portals/patchportal","metadata":{"seo":{"title":"Update a portal","description":"Patch a Portal"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchPortal","name":"Update a portal","isWebhook":false,"pointer":"/paths/~1portals~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a portal","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":"Patch a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Portals"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Portal"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Portals"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Portal"},"children":[]}]}]}]}],"required":true}],"pointer":"/paths/~1portals~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PortalPatchRequest"}},"schemaId":"components/schemas/PortalPatchRequest","pointer":"/paths/~1portals~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/portals/{id}","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PortalPatchRequest"}},"responseCodes":["200","4XX"],"pointer":"/portals/{id}","href":"portals/patchportal","openApiOperationId":"patchPortal","summary":"Update a portal"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/PortalPatchRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PortalPatchRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PortalWithPermittedActions"}},"schemaId":"components/schemas/PortalWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1portals~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PortalWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PortalWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/portals/patchportal"}],"panels":[]}]},"httpPath":"/portals/{id}"},{"label":"Delete a portal","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/portals/deleteportal","routeSlug":"/dash/openapi/portals/deleteportal","metadata":{"seo":{"title":"Delete a portal","description":"Delete a Portal."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deletePortal","name":"Delete a portal","isWebhook":false,"pointer":"/paths/~1portals~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a portal","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":"Delete a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Portals"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Portal"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Portals"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Portal"},"children":[]}]}]}]}],"required":true}],"pointer":"/paths/~1portals~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/portals/{id}","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","4XX"],"pointer":"/portals/{id}","href":"portals/deleteportal","openApiOperationId":"deletePortal","summary":"Delete a portal"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1portals~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/portals/deleteportal"}],"panels":[]}]},"httpPath":"/portals/{id}"},{"label":"Search for portals","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/portals/postportalsearch","routeSlug":"/dash/openapi/portals/postportalsearch","metadata":{"seo":{"title":"Search for portals","description":"Create a new PortalSearch"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postPortalSearch","name":"Search for portals","isWebhook":false,"pointer":"/paths/~1portal-searches/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search for portals","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":"Create a new "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/portals/postportalsearch"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PortalSearch"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PortalSearchRequest"}},"schemaId":"components/schemas/PortalSearchRequest","pointer":"/paths/~1portal-searches/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/portal-searches","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PortalSearchRequest"}},"responseCodes":["200","4XX"],"pointer":"/portal-searches","href":"portals/postportalsearch","openApiOperationId":"postPortalSearch","summary":"Search for portals"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/PortalSearchRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PortalSearchRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PortalSearch"}},"schemaId":"components/schemas/PortalSearch"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1portal-searches/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PortalSearch","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PortalSearch"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/portals/postportalsearch"}],"panels":[]}]},"httpPath":"/portal-searches"}],"content":{"contentType":"group","meta":{"name":"Portals"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Portals","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Portals allow a public (or passcode protected) view on "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Assets"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" within a set of folders."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/portals","summary":"Create a portal","prefix":{"name":"post","color":"post"},"badges":[],"link":"/portals/postportal","deprecated":false},{"title":"/portals/{id}","summary":"Get a portal","prefix":{"name":"get","color":"get"},"badges":[],"link":"/portals/getportal","deprecated":false},{"title":"/portals/{id}","summary":"Update a portal","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/portals/patchportal","deprecated":false},{"title":"/portals/{id}","summary":"Delete a portal","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/portals/deleteportal","deprecated":false},{"title":"/portal-searches","summary":"Search for portals","prefix":{"name":"post","color":"post"},"badges":[],"link":"/portals/postportalsearch","deprecated":false}]}]}]}]}},{"type":"group","label":"Portal Access Tokens","link":"/dash/openapi/portal-access-tokens","routeSlug":"/dash/openapi/portal-access-tokens","items":[{"label":"Get a portal access token","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/portal-access-tokens/getportalaccesstoken","routeSlug":"/dash/openapi/portal-access-tokens/getportalaccesstoken","metadata":{"seo":{"title":"Get a portal access token","description":"Get an access token for making requests as Portal user.  Use this access token in the same way as the normal signed-in user token to make requests with the permissions of the share applied."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPortalAccessToken","name":"Get a portal access token","isWebhook":false,"pointer":"/paths/~1portals~1{id}~1access-token/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a portal access token","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":"Get an access token for making requests as "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Portals"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Portal"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" user.  Use this access token in the same way as the normal signed-in user token to make requests with the permissions of the share applied."},"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":"This endpoint is not authenticated with a Bearer token. Do not send a Bearer Token in the Authorization Header"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the portal has a passcode, select the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"portalPasscode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Authorization header and prefix the passcode with \"Passcode \"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"portalPasscode","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prefix the value with \"Passcode \""},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Portals"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Portal"},"children":[]}]}]}]}],"required":true}],"pointer":"/paths/~1portals~1{id}~1access-token/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/portals/{id}/access-token","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"portalPasscode","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","4XX"],"pointer":"/portals/{id}/access-token","href":"portal-access-tokens/getportalaccesstoken","openApiOperationId":"getPortalAccessToken","summary":"Get a portal access token","securityGroups":[{},{"portalPasscode":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccessTokenWithPermittedActions"}},"schemaId":"components/schemas/AccessTokenWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1portals~1{id}~1access-token/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AccessTokenWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccessTokenWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/portal-access-tokens/getportalaccesstoken"}],"panels":[]}]},"httpPath":"/portals/{id}/access-token"}],"content":{"contentType":"group","meta":{"name":"Portal Access Tokens"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Portal Access Tokens","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/portals/{id}/access-token","summary":"Get a portal access token","prefix":{"name":"get","color":"get"},"badges":[],"link":"/portal-access-tokens/getportalaccesstoken","deprecated":false}]}]}]}]}},{"type":"group","label":"Portal Emails","link":"/dash/openapi/portal-emails","routeSlug":"/dash/openapi/portal-emails","items":[{"label":"Email a link to a portal","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/portal-emails/createportal","routeSlug":"/dash/openapi/portal-emails/createportal","metadata":{"seo":{"title":"Email a link to a portal","description":"Send a Portal via email to a specified email address"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createPortal","name":"Email a link to a portal","isWebhook":false,"pointer":"/paths/~1portal-emails/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Email a link to a portal","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":"Send a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Portals"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Portal"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" via email to a specified email address"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PortalEmailRequest"}},"schemaId":"components/schemas/PortalEmailRequest","pointer":"/paths/~1portal-emails/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/portal-emails","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PortalEmailRequest"}},"responseCodes":["204","4XX"],"pointer":"/portal-emails","href":"portal-emails/createportal","openApiOperationId":"createPortal","summary":"Email a link to a portal"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/PortalEmailRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PortalEmailRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1portal-emails/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/portal-emails/createportal"}],"panels":[]}]},"httpPath":"/portal-emails"}],"content":{"contentType":"group","meta":{"name":"Portal Emails"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Portal Emails","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/portal-emails","summary":"Email a link to a portal","prefix":{"name":"post","color":"post"},"badges":[],"link":"/portal-emails/createportal","deprecated":false}]}]}]}]}},{"type":"group","label":"Publicly Available Portal Datas","link":"/dash/openapi/publicly-available-portal-datas","routeSlug":"/dash/openapi/publicly-available-portal-datas","items":[{"label":"Get public portal data","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/publicly-available-portal-datas/getpubliclyavailableportaldata","routeSlug":"/dash/openapi/publicly-available-portal-datas/getpubliclyavailableportaldata","metadata":{"seo":{"title":"Get public portal data","description":"Get the publicly available data for a portal by subdomain and slug"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPubliclyAvailablePortalData","name":"Get public portal data","isWebhook":false,"pointer":"/paths/~1subdomains~1{subdomain}~1publicly-available-portal-datas~1{slug}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get public portal data","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get the publicly available data for a portal by subdomain and slug\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The subdomain of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Portals"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Portal"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" belongs to"},"children":[]}]}]}],"required":true},{"name":"slug","in":"path","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The slug of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Portals"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Portal"},"children":[]}]}]}]}],"required":true}],"pointer":"/paths/~1subdomains~1{subdomain}~1publicly-available-portal-datas~1{slug}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/subdomains/{subdomain}/publicly-available-portal-datas/{slug}","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"schema_25"},{"name":"slug","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","4XX"],"pointer":"/subdomains/{subdomain}/publicly-available-portal-datas/{slug}","href":"publicly-available-portal-datas/getpubliclyavailableportaldata","openApiOperationId":"getPubliclyAvailablePortalData","summary":"Get public portal data"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PubliclyAvailablePortalDataWithPermittedActions"}},"schemaId":"components/schemas/PubliclyAvailablePortalDataWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1subdomains~1{subdomain}~1publicly-available-portal-datas~1{slug}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PubliclyAvailablePortalDataWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PubliclyAvailablePortalDataWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/publicly-available-portal-datas/getpubliclyavailableportaldata"}],"panels":[]}]},"httpPath":"/subdomains/{subdomain}/publicly-available-portal-datas/{slug}"}],"content":{"contentType":"group","meta":{"name":"Publicly Available Portal Datas"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Publicly Available Portal Datas","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/subdomains/{subdomain}/publicly-available-portal-datas/{slug}","summary":"Get public portal data","prefix":{"name":"get","color":"get"},"badges":[],"link":"/publicly-available-portal-datas/getpubliclyavailableportaldata","deprecated":false}]}]}]}]}},{"type":"separator","label":"Saved Search","content":null},{"type":"group","label":"Saved Searches","link":"/dash/openapi/saved-searches","routeSlug":"/dash/openapi/saved-searches","items":[{"label":"Create a saved search","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/saved-searches/postsavedsearch","routeSlug":"/dash/openapi/saved-searches/postsavedsearch","metadata":{"seo":{"title":"Create a saved search","description":"Create a new SavedSearch resource."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postSavedSearch","name":"Create a saved search","isWebhook":false,"pointer":"/paths/~1saved-searches/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a saved search","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":"Create a new "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Saved-Searches"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SavedSearch"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SavedSearchRequest"}},"schemaId":"components/schemas/SavedSearchRequest","pointer":"/paths/~1saved-searches/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/saved-searches","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SavedSearchRequest"}},"responseCodes":["200","4XX"],"pointer":"/saved-searches","href":"saved-searches/postsavedsearch","openApiOperationId":"postSavedSearch","summary":"Create a saved search"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/SavedSearchRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SavedSearchRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SavedSearch"}},"schemaId":"components/schemas/SavedSearch"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1saved-searches/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SavedSearch","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SavedSearch"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/saved-searches/postsavedsearch"}],"panels":[]}]},"httpPath":"/saved-searches"},{"label":"Get a saved search","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/saved-searches/getsavedsearch","routeSlug":"/dash/openapi/saved-searches/getsavedsearch","metadata":{"seo":{"title":"Get a saved search","description":"Get a SavedSearch resource."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSavedSearch","name":"Get a saved search","isWebhook":false,"pointer":"/paths/~1saved-searches~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a saved search","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":"Get a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Saved-Searches"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SavedSearch"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Saved-Searches"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SavedSearch"},"children":[]}]}]}]}],"required":true}],"pointer":"/paths/~1saved-searches~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/saved-searches/{id}","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","4XX"],"pointer":"/saved-searches/{id}","href":"saved-searches/getsavedsearch","openApiOperationId":"getSavedSearch","summary":"Get a saved search"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SavedSearchWithPermittedActions"}},"schemaId":"components/schemas/SavedSearchWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1saved-searches~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SavedSearchWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SavedSearchWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/saved-searches/getsavedsearch"}],"panels":[]}]},"httpPath":"/saved-searches/{id}"},{"label":"Update a saved search","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/saved-searches/patchsavedsearch","routeSlug":"/dash/openapi/saved-searches/patchsavedsearch","metadata":{"seo":{"title":"Update a saved search","description":"Update a SavedSearch resource. Only the provided fields will be updated"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchSavedSearch","name":"Update a saved search","isWebhook":false,"pointer":"/paths/~1saved-searches~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a saved search","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":"Update a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Saved-Searches"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SavedSearch"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource. Only the provided fields will be updated"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Saved-Searches"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SavedSearch"},"children":[]}]}]}]}],"required":true}],"pointer":"/paths/~1saved-searches~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SavedSearchPatchRequest"}},"schemaId":"components/schemas/SavedSearchPatchRequest","pointer":"/paths/~1saved-searches~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/saved-searches/{id}","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SavedSearchPatchRequest"}},"responseCodes":["200","4XX"],"pointer":"/saved-searches/{id}","href":"saved-searches/patchsavedsearch","openApiOperationId":"patchSavedSearch","summary":"Update a saved search"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/SavedSearchPatchRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SavedSearchPatchRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SavedSearchWithPermittedActions"}},"schemaId":"components/schemas/SavedSearchWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1saved-searches~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SavedSearchWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SavedSearchWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/saved-searches/patchsavedsearch"}],"panels":[]}]},"httpPath":"/saved-searches/{id}"},{"label":"Search for saved searches","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/saved-searches/postsavedsearchsearch","routeSlug":"/dash/openapi/saved-searches/postsavedsearchsearch","metadata":{"seo":{"title":"Search for saved searches","description":"Create a new SavedSearchSearch"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postSavedSearchSearch","name":"Search for saved searches","isWebhook":false,"pointer":"/paths/~1saved-search-searches/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search for saved searches","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":"Create a new "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/saved-searches/postsavedsearch"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SavedSearchSearch"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The only use of a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/saved-searches/postsavedsearch"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SavedSearchSearch"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as of now is to retrieve all the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Saved-Search"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SavedSearch"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources created by a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Users"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SavedSearchSearchRequest","exampleIds":["paths/~1saved-search-searches/post/requestBody/content/application~1json/examples/Search for saved searches created by a user"]}},"schemaId":"components/schemas/SavedSearchSearchRequest","exampleIds":["paths/~1saved-search-searches/post/requestBody/content/application~1json/examples/Search for saved searches created by a user"],"pointer":"/paths/~1saved-search-searches/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/saved-search-searches","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SavedSearchSearchRequest","exampleIds":["paths/~1saved-search-searches/post/requestBody/content/application~1json/examples/Search for saved searches created by a user"]}},"responseCodes":["200","4XX"],"pointer":"/saved-search-searches","href":"saved-searches/postsavedsearchsearch","openApiOperationId":"postSavedSearchSearch","summary":"Search for saved searches"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/SavedSearchSearchRequest","exampleIds":["paths/~1saved-search-searches/post/requestBody/content/application~1json/examples/Search for saved searches created by a user"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SavedSearchSearchRequest","exampleIds":["paths/~1saved-search-searches/post/requestBody/content/application~1json/examples/Search for saved searches created by a user"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SavedSearchSearch","exampleIds":["paths/~1saved-search-searches/post/responses/200/content/application~1json/examples/Search for saved searches created by a user"]}},"schemaId":"components/schemas/SavedSearchSearch","exampleIds":["paths/~1saved-search-searches/post/responses/200/content/application~1json/examples/Search for saved searches created by a user"]},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1saved-search-searches/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SavedSearchSearch","exampleIds":["paths/~1saved-search-searches/post/responses/200/content/application~1json/examples/Search for saved searches created by a user"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SavedSearchSearch","exampleIds":["paths/~1saved-search-searches/post/responses/200/content/application~1json/examples/Search for saved searches created by a user"]}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/saved-searches/postsavedsearchsearch"}],"panels":[]}]},"httpPath":"/saved-search-searches"}],"content":{"contentType":"group","meta":{"name":"Saved Searches"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Saved Searches","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A SavedSearch is an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetSearch"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(/dash/openapi/assets/postassetsearch)"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".criterion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetSearch"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(/dash/openapi/assets/postassetsearch)"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".sorts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that have been saved by a user.  The user may also chose to receive email updates every time a new asset matches the saved criterion."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Searching allows you to find "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Saved-Searches"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SavedSearches"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources in your Dash matching specific criteria."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/saved-searches","summary":"Create a saved search","prefix":{"name":"post","color":"post"},"badges":[],"link":"/saved-searches/postsavedsearch","deprecated":false},{"title":"/saved-searches/{id}","summary":"Get a saved search","prefix":{"name":"get","color":"get"},"badges":[],"link":"/saved-searches/getsavedsearch","deprecated":false},{"title":"/saved-searches/{id}","summary":"Update a saved search","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/saved-searches/patchsavedsearch","deprecated":false},{"title":"/saved-search-searches","summary":"Search for saved searches","prefix":{"name":"post","color":"post"},"badges":[],"link":"/saved-searches/postsavedsearchsearch","deprecated":false}]}]}]}]}},{"type":"separator","label":"User","content":null},{"type":"group","label":"Groups","link":"/dash/openapi/groups","routeSlug":"/dash/openapi/groups","items":[{"label":"Get all groups","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/groups/getgroups","routeSlug":"/dash/openapi/groups/getgroups","metadata":{"seo":{"title":"Get all groups","description":"Get all of the Groups in the current Account"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getGroups","name":"Get all groups","isWebhook":false,"pointer":"/paths/~1groups/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all groups","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":"Get all of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Group"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Groups"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the current "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Account"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Account"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/groups","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","4XX"],"pointer":"/groups","href":"groups/getgroups","openApiOperationId":"getGroups","summary":"Get all groups"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GroupsWithPermittedActions"}},"schemaId":"components/schemas/GroupsWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1groups/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GroupsWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GroupsWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/groups/getgroups"}],"panels":[]}]},"httpPath":"/groups"},{"label":"Create a group","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/groups/postgroup","routeSlug":"/dash/openapi/groups/postgroup","metadata":{"seo":{"title":"Create a group","description":"Create a Group"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postGroup","name":"Create a group","isWebhook":false,"pointer":"/paths/~1groups/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a group","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":"Create a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Group"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Group"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GroupRequest"}},"schemaId":"components/schemas/GroupRequest","pointer":"/paths/~1groups/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/groups","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/GroupRequest"}},"responseCodes":["200","4XX"],"pointer":"/groups","href":"groups/postgroup","openApiOperationId":"postGroup","summary":"Create a group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/GroupRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GroupRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GroupWithPermittedActions"}},"schemaId":"components/schemas/GroupWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1groups/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GroupWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GroupWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/groups/postgroup"}],"panels":[]}]},"httpPath":"/groups"},{"label":"Get a group","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/groups/getgroup","routeSlug":"/dash/openapi/groups/getgroup","metadata":{"seo":{"title":"Get a group","description":"Get a Group"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getGroup","name":"Get a group","isWebhook":false,"pointer":"/paths/~1groups~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a group","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":"Get a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Group"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Group"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_25","description":"The unique ID of the group","required":true,"example":"cff665ca-ce35-5418-b9d5-70ee815db4bc"}],"pointer":"/paths/~1groups~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/groups/{id}","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"cff665ca-ce35-5418-b9d5-70ee815db4bc","schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","4XX"],"pointer":"/groups/{id}","href":"groups/getgroup","openApiOperationId":"getGroup","summary":"Get a group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GroupWithPermittedActions"}},"schemaId":"components/schemas/GroupWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1groups~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GroupWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GroupWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/groups/getgroup"}],"panels":[]}]},"httpPath":"/groups/{id}"},{"label":"Update a group","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/groups/patchgroup","routeSlug":"/dash/openapi/groups/patchgroup","metadata":{"seo":{"title":"Update a group","description":"Update a Group"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchGroup","name":"Update a group","isWebhook":false,"pointer":"/paths/~1groups~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a group","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":"Update a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Group"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Group"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_25","description":"The unique ID of the group","required":true,"example":"cff665ca-ce35-5418-b9d5-70ee815db4bc"}],"pointer":"/paths/~1groups~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GroupPatchRequest"}},"schemaId":"components/schemas/GroupPatchRequest","pointer":"/paths/~1groups~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/groups/{id}","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"cff665ca-ce35-5418-b9d5-70ee815db4bc","schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/GroupPatchRequest"}},"responseCodes":["200","4XX"],"pointer":"/groups/{id}","href":"groups/patchgroup","openApiOperationId":"patchGroup","summary":"Update a group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/GroupPatchRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GroupPatchRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GroupWithPermittedActions"}},"schemaId":"components/schemas/GroupWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1groups~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GroupWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GroupWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/groups/patchgroup"}],"panels":[]}]},"httpPath":"/groups/{id}"},{"label":"Delete a group","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/groups/deletegroup","routeSlug":"/dash/openapi/groups/deletegroup","metadata":{"seo":{"title":"Delete a group","description":"Delete a Group"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteGroup","name":"Delete a group","isWebhook":false,"pointer":"/paths/~1groups~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a group","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":"Delete a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Group"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Group"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_25","description":"The unique ID of the group","required":true,"example":"cff665ca-ce35-5418-b9d5-70ee815db4bc"}],"pointer":"/paths/~1groups~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/groups/{id}","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"cff665ca-ce35-5418-b9d5-70ee815db4bc","schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","4XX"],"pointer":"/groups/{id}","href":"groups/deletegroup","openApiOperationId":"deleteGroup","summary":"Delete a group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1groups~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/groups/deletegroup"}],"panels":[]}]},"httpPath":"/groups/{id}"}],"content":{"contentType":"group","meta":{"name":"Groups"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Groups","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Groups"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Groups"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are used to specify the permissions of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Users"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Users"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in Dash."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/groups","summary":"Get all groups","prefix":{"name":"get","color":"get"},"badges":[],"link":"/groups/getgroups","deprecated":false},{"title":"/groups","summary":"Create a group","prefix":{"name":"post","color":"post"},"badges":[],"link":"/groups/postgroup","deprecated":false},{"title":"/groups/{id}","summary":"Get a group","prefix":{"name":"get","color":"get"},"badges":[],"link":"/groups/getgroup","deprecated":false},{"title":"/groups/{id}","summary":"Update a group","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/groups/patchgroup","deprecated":false},{"title":"/groups/{id}","summary":"Delete a group","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/groups/deletegroup","deprecated":false}]}]}]}]}},{"type":"group","label":"Staff Members","link":"/dash/openapi/staff-members","routeSlug":"/dash/openapi/staff-members","items":[{"label":"Delete a staff member","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/staff-members/deletestaffmember","routeSlug":"/dash/openapi/staff-members/deletestaffmember","metadata":{"seo":{"title":"Delete a staff member","description":"Delete Staff Member with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteStaffMember","name":"Delete a staff member","isWebhook":false,"pointer":"/paths/~1staff-members~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a staff member","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":"Delete "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Staff-Members"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Staff Member"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with the specified ID."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Staff-Members"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Staff Member"},"children":[]}]}]}]}],"required":true}],"pointer":"/paths/~1staff-members~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/staff-members/{id}","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","4XX"],"pointer":"/staff-members/{id}","href":"staff-members/deletestaffmember","openApiOperationId":"deleteStaffMember","summary":"Delete a staff member"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1staff-members~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/staff-members/deletestaffmember"}],"panels":[]}]},"httpPath":"/staff-members/{id}"},{"label":"Get all staff members","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/staff-members/getstaffmembers","routeSlug":"/dash/openapi/staff-members/getstaffmembers","metadata":{"seo":{"title":"Get all staff members","description":"Get all Staff Members."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getStaffMembers","name":"Get all staff members","isWebhook":false,"pointer":"/paths/~1staff-members/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all staff members","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":"Get all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Staff-Members"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Staff Members"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/staff-members","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","4XX"],"pointer":"/staff-members","href":"staff-members/getstaffmembers","openApiOperationId":"getStaffMembers","summary":"Get all staff members"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_39"}},"schemaId":"schema_39"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1staff-members/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_39","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_39"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/staff-members/getstaffmembers"}],"panels":[]}]},"httpPath":"/staff-members"},{"label":"Create a staff member","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/staff-members/poststaffmember","routeSlug":"/dash/openapi/staff-members/poststaffmember","metadata":{"seo":{"title":"Create a staff member","description":"Create a new Staff Member. Staff Members can log in to any Dash account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postStaffMember","name":"Create a staff member","isWebhook":false,"pointer":"/paths/~1staff-members/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a staff member","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":"Create a new "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Staff-Members"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Staff Member"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Staff Members can log in to any Dash account."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/StaffMemberRequest"}},"schemaId":"components/schemas/StaffMemberRequest","pointer":"/paths/~1staff-members/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/staff-members","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/StaffMemberRequest"}},"responseCodes":["200","4XX"],"pointer":"/staff-members","href":"staff-members/poststaffmember","openApiOperationId":"postStaffMember","summary":"Create a staff member"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/StaffMemberRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/StaffMemberRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StaffMember"}},"schemaId":"components/schemas/StaffMember"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1staff-members/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/StaffMember","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StaffMember"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/staff-members/poststaffmember"}],"panels":[]}]},"httpPath":"/staff-members"}],"content":{"contentType":"group","meta":{"name":"Staff Members"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Staff Members","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Coming soon; "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"mailto:help@dash.app"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contact us"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if you need access to this API endpoint."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/staff-members/{id}","summary":"Delete a staff member","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/staff-members/deletestaffmember","deprecated":false},{"title":"/staff-members","summary":"Get all staff members","prefix":{"name":"get","color":"get"},"badges":[],"link":"/staff-members/getstaffmembers","deprecated":false},{"title":"/staff-members","summary":"Create a staff member","prefix":{"name":"post","color":"post"},"badges":[],"link":"/staff-members/poststaffmember","deprecated":false}]}]}]}]}},{"type":"group","label":"Users","link":"/dash/openapi/users","routeSlug":"/dash/openapi/users","items":[{"label":"Create a user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/users/postuser","routeSlug":"/dash/openapi/users/postuser","metadata":{"seo":{"title":"Create a user","description":"Create a new User in the current account"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postUser","name":"Create a user","isWebhook":false,"pointer":"/paths/~1users/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a user","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":"Create a new "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Users"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the current account"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UserRequest"}},"schemaId":"components/schemas/UserRequest","pointer":"/paths/~1users/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/users","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UserRequest"}},"responseCodes":["200","4XX"],"pointer":"/users","href":"users/postuser","openApiOperationId":"postUser","summary":"Create a user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/UserRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UserRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountUserWithPermittedActions"}},"schemaId":"components/schemas/AccountUserWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1users/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AccountUserWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountUserWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/postuser"}],"panels":[]}]},"httpPath":"/users"},{"label":"Get a user","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/users/getuser","routeSlug":"/dash/openapi/users/getuser","metadata":{"seo":{"title":"Get a user","description":"Get a User"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getUser","name":"Get a user","isWebhook":false,"pointer":"/paths/~1users~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a user","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":"Get a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Users"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Users"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or the User's email"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1users~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/users/{id}","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","4XX"],"pointer":"/users/{id}","href":"users/getuser","openApiOperationId":"getUser","summary":"Get a user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UserWithNoPermittedActions"}},"schemaId":"components/schemas/UserWithNoPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1users~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/UserWithNoPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UserWithNoPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/getuser"}],"panels":[]}]},"httpPath":"/users/{id}"},{"label":"Update a user","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/users/patchuser","routeSlug":"/dash/openapi/users/patchuser","metadata":{"seo":{"title":"Update a user","description":"Patch a User"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchUser","name":"Update a user","isWebhook":false,"pointer":"/paths/~1users~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a user","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":"Patch a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Users"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Users"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or the User's email"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1users~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UserPatchRequest"}},"schemaId":"components/schemas/UserPatchRequest","pointer":"/paths/~1users~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/users/{id}","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UserPatchRequest"}},"responseCodes":["200","4XX"],"pointer":"/users/{id}","href":"users/patchuser","openApiOperationId":"patchUser","summary":"Update a user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/UserPatchRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UserPatchRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountUserWithPermittedActions"}},"schemaId":"components/schemas/AccountUserWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1users~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AccountUserWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountUserWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/patchuser"}],"panels":[]}]},"httpPath":"/users/{id}"},{"label":"Delete a User","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/users/deleteuser","routeSlug":"/dash/openapi/users/deleteuser","metadata":{"seo":{"title":"Delete a User","description":"Delete a User and delete all AssetShares belonging to that user"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteUser","name":"Delete a User","isWebhook":false,"pointer":"/paths/~1users~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a User","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":"Delete a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Users"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and delete all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Asset-Shares"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetShares"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" belonging to that user"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Users"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or the User's email"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1users~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/users/{id}","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","4XX"],"pointer":"/users/{id}","href":"users/deleteuser","openApiOperationId":"deleteUser","summary":"Delete a User"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1users~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/deleteuser"}],"panels":[]}]},"httpPath":"/users/{id}"},{"label":"Create users","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/users/postuserbatchjob","routeSlug":"/dash/openapi/users/postuserbatchjob","metadata":{"seo":{"title":"Create users","description":"Create new User resources in the current account"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postUserBatchJob","name":"Create users","isWebhook":false,"pointer":"/paths/~1user-batch-jobs/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create users","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":"Create new "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Users"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources in the current account"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UserBatchRequest"}},"schemaId":"components/schemas/UserBatchRequest","pointer":"/paths/~1user-batch-jobs/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/user-batch-jobs","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UserBatchRequest"}},"responseCodes":["200","4XX"],"pointer":"/user-batch-jobs","href":"users/postuserbatchjob","openApiOperationId":"postUserBatchJob","summary":"Create users"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/UserBatchRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UserBatchRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UserBatchJob"}},"schemaId":"components/schemas/UserBatchJob"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1user-batch-jobs/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/UserBatchJob","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UserBatchJob"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/postuserbatchjob"}],"panels":[]}]},"httpPath":"/user-batch-jobs"},{"label":"Get the status of creating users","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/users/getuserbatchjob","routeSlug":"/dash/openapi/users/getuserbatchjob","metadata":{"seo":{"title":"Get the status of creating users","description":"Get the status and eventual result of an UserBatchJob"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getUserBatchJob","name":"Get the status of creating users","isWebhook":false,"pointer":"/paths/~1user-batch-jobs~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get the status of creating users","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":"Get the status and eventual result of an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/users/postuserbatchjob"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UserBatchJob"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/users/postuserbatchjob"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UserBatchJob"},"children":[]}]}]}]}],"required":true}],"pointer":"/paths/~1user-batch-jobs~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/user-batch-jobs/{id}","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","4XX"],"pointer":"/user-batch-jobs/{id}","href":"users/getuserbatchjob","openApiOperationId":"getUserBatchJob","summary":"Get the status of creating users"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UserBatchJob"}},"schemaId":"components/schemas/UserBatchJob"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1user-batch-jobs~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/UserBatchJob","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UserBatchJob"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/getuserbatchjob"}],"panels":[]}]},"httpPath":"/user-batch-jobs/{id}"},{"label":"Search for users","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/users/postusersearch","routeSlug":"/dash/openapi/users/postusersearch","metadata":{"seo":{"title":"Search for users","description":"Create a new UserSearch"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postUserSearch","name":"Search for users","isWebhook":false,"pointer":"/paths/~1user-searches/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search for users","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":"Create a new "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UserSearch"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UserSearchRequest"}},"schemaId":"components/schemas/UserSearchRequest","pointer":"/paths/~1user-searches/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/user-searches","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UserSearchRequest"}},"responseCodes":["200","4XX"],"pointer":"/user-searches","href":"users/postusersearch","openApiOperationId":"postUserSearch","summary":"Search for users"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/UserSearchRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UserSearchRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UserSearch"}},"schemaId":"components/schemas/UserSearch"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1user-searches/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/UserSearch","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UserSearch"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/postusersearch"}],"panels":[]}]},"httpPath":"/user-searches"},{"label":"Delete a user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/users/postdeleteuser","routeSlug":"/dash/openapi/users/postdeleteuser","metadata":{"seo":{"title":"Delete a user","description":"Delete a User with the option to delete all AssetShares belonging to that user"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postDeleteUser","name":"Delete a user","isWebhook":false,"pointer":"/paths/~1user-deletes/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a user","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":"Delete a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Users"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with the option to delete all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Asset-Shares"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetShares"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" belonging to that user"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UserDeleteRequest"}},"schemaId":"components/schemas/UserDeleteRequest","pointer":"/paths/~1user-deletes/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/user-deletes","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UserDeleteRequest"}},"responseCodes":["204","4XX"],"pointer":"/user-deletes","href":"users/postdeleteuser","openApiOperationId":"postDeleteUser","summary":"Delete a user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/UserDeleteRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UserDeleteRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1user-deletes/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/postdeleteuser"}],"panels":[]}]},"httpPath":"/user-deletes"},{"label":"Get the current user","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/users/getcurrentuser","routeSlug":"/dash/openapi/users/getcurrentuser","metadata":{"seo":{"title":"Get the current user","description":"Get the currently authenticated User"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCurrentUser","name":"Get the current user","isWebhook":false,"pointer":"/paths/~1current-user/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get the current user","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":"Get the currently authenticated "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Users"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/current-user","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","4XX"],"pointer":"/current-user","href":"users/getcurrentuser","openApiOperationId":"getCurrentUser","summary":"Get the current user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UserWithPermittedActions"}},"schemaId":"components/schemas/UserWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1current-user/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/UserWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UserWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/getcurrentuser"}],"panels":[]}]},"httpPath":"/current-user"},{"label":"Check the creation status of the current user","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/users/getcurrentusercreationstatus","routeSlug":"/dash/openapi/users/getcurrentusercreationstatus","metadata":{"seo":{"title":"Check the creation status of the current user","description":"Get the currently authenticated User's creation status (used for detecting if a temporary signup token has been used)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCurrentUserCreationStatus","name":"Check the creation status of the current user","isWebhook":false,"pointer":"/paths/~1current-user-creation-status/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Check the creation status of the current user","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":"Get the currently authenticated "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Users"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'s creation status (used for detecting if a temporary signup token has been used)"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/current-user-creation-status","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","4XX"],"pointer":"/current-user-creation-status","href":"users/getcurrentusercreationstatus","openApiOperationId":"getCurrentUserCreationStatus","summary":"Check the creation status of the current user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UserCreationStatusResponseWithPermittedActions"}},"schemaId":"components/schemas/UserCreationStatusResponseWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1current-user-creation-status/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/UserCreationStatusResponseWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UserCreationStatusResponseWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/getcurrentusercreationstatus"}],"panels":[]}]},"httpPath":"/current-user-creation-status"},{"label":"Create a platform user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/users/postplatformuser","routeSlug":"/dash/openapi/users/postplatformuser","metadata":{"seo":{"title":"Create a platform user","description":"Create a new Platform User"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postPlatformUser","name":"Create a platform user","isWebhook":false,"pointer":"/paths/~1platform~1users/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a platform user","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":"Create a new "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/users/postplatformuser"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Platform User"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PlatformUserRequest"}},"schemaId":"components/schemas/PlatformUserRequest","pointer":"/paths/~1platform~1users/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/platform/users","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PlatformUserRequest"}},"responseCodes":["200","4XX"],"pointer":"/platform/users","href":"users/postplatformuser","openApiOperationId":"postPlatformUser","summary":"Create a platform user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/PlatformUserRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PlatformUserRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1platform~1users/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/postplatformuser"}],"panels":[]}]},"httpPath":"/platform/users"},{"label":"Patch a platform user","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/users/patchplatformuser","routeSlug":"/dash/openapi/users/patchplatformuser","metadata":{"seo":{"title":"Patch a platform user","description":"Update a Platform User"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchPlatformUser","name":"Patch a platform user","isWebhook":false,"pointer":"/paths/~1platform~1users~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Patch a platform user","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":"Update a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Platform User"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Platform User"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1platform~1users~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PlatformUserPatchRequest"}},"schemaId":"components/schemas/PlatformUserPatchRequest","pointer":"/paths/~1platform~1users~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/platform/users/{id}","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PlatformUserPatchRequest"}},"responseCodes":["200","4XX"],"pointer":"/platform/users/{id}","href":"users/patchplatformuser","openApiOperationId":"patchPlatformUser","summary":"Patch a platform user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/PlatformUserPatchRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PlatformUserPatchRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1platform~1users~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/patchplatformuser"}],"panels":[]}]},"httpPath":"/platform/users/{id}"},{"label":"Create a platform user profile picture upload","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/users/createplatformuserprofilepictureupload","routeSlug":"/dash/openapi/users/createplatformuserprofilepictureupload","metadata":{"seo":{"title":"Create a platform user profile picture upload","description":"Create an upload URL for a platform user's profile picture"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createPlatformUserProfilePictureUpload","name":"Create a platform user profile picture upload","isWebhook":false,"pointer":"/paths/~1platform~1users~1{id}~1profile-picture-upload/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a platform user profile picture upload","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create an upload URL for a platform user's profile picture\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Platform User"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1platform~1users~1{id}~1profile-picture-upload/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PlatformUserProfilePictureUploadRequest"}},"schemaId":"components/schemas/PlatformUserProfilePictureUploadRequest","pointer":"/paths/~1platform~1users~1{id}~1profile-picture-upload/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/platform/users/{id}/profile-picture-upload","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PlatformUserProfilePictureUploadRequest"}},"responseCodes":["200","4XX"],"pointer":"/platform/users/{id}/profile-picture-upload","href":"users/createplatformuserprofilepictureupload","openApiOperationId":"createPlatformUserProfilePictureUpload","summary":"Create a platform user profile picture upload"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/PlatformUserProfilePictureUploadRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PlatformUserProfilePictureUploadRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformUserProfilePictureUpload"}},"schemaId":"components/schemas/PlatformUserProfilePictureUpload"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1platform~1users~1{id}~1profile-picture-upload/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PlatformUserProfilePictureUpload","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformUserProfilePictureUpload"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/createplatformuserprofilepictureupload"}],"panels":[]}]},"httpPath":"/platform/users/{id}/profile-picture-upload"},{"label":"Update a platform user profile picture","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/users/updateplatformuserprofilepicture","routeSlug":"/dash/openapi/users/updateplatformuserprofilepicture","metadata":{"seo":{"title":"Update a platform user profile picture","description":"Update the stored profile picture URL for a platform user"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updatePlatformUserProfilePicture","name":"Update a platform user profile picture","isWebhook":false,"pointer":"/paths/~1platform~1users~1{id}~1profile-picture/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a platform user profile picture","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update the stored profile picture URL for a platform user\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Platform User"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1platform~1users~1{id}~1profile-picture/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PlatformUserProfilePictureRequest"}},"schemaId":"components/schemas/PlatformUserProfilePictureRequest","pointer":"/paths/~1platform~1users~1{id}~1profile-picture/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/platform/users/{id}/profile-picture","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PlatformUserProfilePictureRequest"}},"responseCodes":["200","4XX"],"pointer":"/platform/users/{id}/profile-picture","href":"users/updateplatformuserprofilepicture","openApiOperationId":"updatePlatformUserProfilePicture","summary":"Update a platform user profile picture"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/PlatformUserProfilePictureRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PlatformUserProfilePictureRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1platform~1users~1{id}~1profile-picture/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/updateplatformuserprofilepicture"}],"panels":[]}]},"httpPath":"/platform/users/{id}/profile-picture"},{"label":"Delete a platform user profile picture","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/users/deleteplatformuserprofilepicture","routeSlug":"/dash/openapi/users/deleteplatformuserprofilepicture","metadata":{"seo":{"title":"Delete a platform user profile picture","description":"Delete the stored custom profile picture for a platform user"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deletePlatformUserProfilePicture","name":"Delete a platform user profile picture","isWebhook":false,"pointer":"/paths/~1platform~1users~1{id}~1profile-picture/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a platform user profile picture","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete the stored custom profile picture for a platform user\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Platform User"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1platform~1users~1{id}~1profile-picture/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/platform/users/{id}/profile-picture","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","4XX"],"pointer":"/platform/users/{id}/profile-picture","href":"users/deleteplatformuserprofilepicture","openApiOperationId":"deletePlatformUserProfilePicture","summary":"Delete a platform user profile picture"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1platform~1users~1{id}~1profile-picture/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/deleteplatformuserprofilepicture"}],"panels":[]}]},"httpPath":"/platform/users/{id}/profile-picture"},{"label":"Get accounts which the current user has a seat in","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/users/postplatformcurrentuseraccountssearch","routeSlug":"/dash/openapi/users/postplatformcurrentuseraccountssearch","metadata":{"seo":{"title":"Get accounts which the current user has a seat in","description":"Get accounts which the currently authenticated Platform User's has a seat in"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postPlatformCurrentUserAccountsSearch","name":"Get accounts which the current user has a seat in","isWebhook":false,"pointer":"/paths/~1platform~1current-user-account-searches/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get accounts which the current user has a seat in","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":"Get accounts which the currently authenticated "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/users/postplatformuser"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Platform User"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'s has a seat in"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PlatformCurrentUserAccountSearchRequest"}},"schemaId":"components/schemas/PlatformCurrentUserAccountSearchRequest","pointer":"/paths/~1platform~1current-user-account-searches/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/platform/current-user-account-searches","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PlatformCurrentUserAccountSearchRequest"}},"responseCodes":["200","4XX"],"pointer":"/platform/current-user-account-searches","href":"users/postplatformcurrentuseraccountssearch","openApiOperationId":"postPlatformCurrentUserAccountsSearch","summary":"Get accounts which the current user has a seat in"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/PlatformCurrentUserAccountSearchRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PlatformCurrentUserAccountSearchRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PubliclyAvailableAccountDataSearch"}},"schemaId":"components/schemas/PubliclyAvailableAccountDataSearch"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1platform~1current-user-account-searches/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PubliclyAvailableAccountDataSearch","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PubliclyAvailableAccountDataSearch"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/postplatformcurrentuseraccountssearch"}],"panels":[]}]},"httpPath":"/platform/current-user-account-searches"},{"label":"Request a password reset","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/users/postplatformuserforgottenpassword","routeSlug":"/dash/openapi/users/postplatformuserforgottenpassword","metadata":{"seo":{"title":"Request a password reset","description":"Request a Platform User password reset"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postPlatformUserForgottenPassword","name":"Request a password reset","isWebhook":false,"pointer":"/paths/~1platform~1user-forgotten-passwords/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Request a password reset","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":"Request a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/users/postplatformuser"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Platform User"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" password reset"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PlatformUserForgottenPasswordRequest"}},"schemaId":"components/schemas/PlatformUserForgottenPasswordRequest","pointer":"/paths/~1platform~1user-forgotten-passwords/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/platform/user-forgotten-passwords","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/PlatformUserForgottenPasswordRequest"}},"responseCodes":["200","4XX"],"pointer":"/platform/user-forgotten-passwords","href":"users/postplatformuserforgottenpassword","openApiOperationId":"postPlatformUserForgottenPassword","summary":"Request a password reset"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/PlatformUserForgottenPasswordRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PlatformUserForgottenPasswordRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1platform~1user-forgotten-passwords/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/postplatformuserforgottenpassword"}],"panels":[]}]},"httpPath":"/platform/user-forgotten-passwords"},{"label":"Reset a password","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/users/postplatformuserresetpassword","routeSlug":"/dash/openapi/users/postplatformuserresetpassword","metadata":{"seo":{"title":"Reset a password","description":"Reset a Platform User password"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postPlatformUserResetPassword","name":"Reset a password","isWebhook":false,"pointer":"/paths/~1platform~1user-reset-passwords/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reset a password","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":"Reset a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/users/postplatformuser"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Platform User"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" password"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PlatformUserResetPasswordRequest"}},"schemaId":"components/schemas/PlatformUserResetPasswordRequest","pointer":"/paths/~1platform~1user-reset-passwords/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/platform/user-reset-passwords","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PlatformUserResetPasswordRequest"}},"responseCodes":["200","4XX"],"pointer":"/platform/user-reset-passwords","href":"users/postplatformuserresetpassword","openApiOperationId":"postPlatformUserResetPassword","summary":"Reset a password"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/PlatformUserResetPasswordRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PlatformUserResetPasswordRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1platform~1user-reset-passwords/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/postplatformuserresetpassword"}],"panels":[]}]},"httpPath":"/platform/user-reset-passwords"},{"label":"Get a sign-up token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/users/postplatformusersignuptoken","routeSlug":"/dash/openapi/users/postplatformusersignuptoken","metadata":{"seo":{"title":"Get a sign-up token","description":"Get an authentication token needed to create a Platform User"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postPlatformUserSignUpToken","name":"Get a sign-up token","isWebhook":false,"pointer":"/paths/~1platform~1user-sign-up-tokens/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a sign-up token","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":"Get an authentication token needed to create a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/users/postplatformuser"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Platform User"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PlatformUserSignUpTokenRequest"}},"schemaId":"components/schemas/PlatformUserSignUpTokenRequest","pointer":"/paths/~1platform~1user-sign-up-tokens/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/platform/user-sign-up-tokens","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/PlatformUserSignUpTokenRequest"}},"responseCodes":["200","4XX"],"pointer":"/platform/user-sign-up-tokens","href":"users/postplatformusersignuptoken","openApiOperationId":"postPlatformUserSignUpToken","summary":"Get a sign-up token"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/PlatformUserSignUpTokenRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PlatformUserSignUpTokenRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformUserSignUpToken"}},"schemaId":"components/schemas/PlatformUserSignUpToken"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1platform~1user-sign-up-tokens/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PlatformUserSignUpToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformUserSignUpToken"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/postplatformusersignuptoken"}],"panels":[]}]},"httpPath":"/platform/user-sign-up-tokens"},{"label":"Request verification code for sign-up","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/users/postplatformuserverification","routeSlug":"/dash/openapi/users/postplatformuserverification","metadata":{"seo":{"title":"Request verification code for sign-up","description":"Request verification code needed to retrieve authentication token to create a Platform User"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postPlatformUserVerification","name":"Request verification code for sign-up","isWebhook":false,"pointer":"/paths/~1platform~1user-verifications/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Request verification code for sign-up","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":"Request verification code needed to retrieve authentication token to create a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/users/postplatformuser"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Platform User"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PlatformUserVerificationRequest"}},"schemaId":"components/schemas/PlatformUserVerificationRequest","pointer":"/paths/~1platform~1user-verifications/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/platform/user-verifications","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/PlatformUserVerificationRequest"}},"responseCodes":["200","4XX"],"pointer":"/platform/user-verifications","href":"users/postplatformuserverification","openApiOperationId":"postPlatformUserVerification","summary":"Request verification code for sign-up"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/PlatformUserVerificationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PlatformUserVerificationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1platform~1user-verifications/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/postplatformuserverification"}],"panels":[]}]},"httpPath":"/platform/user-verifications"}],"content":{"contentType":"group","meta":{"name":"Users"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Users","showPageActions":true},{"nodeType":"markdoc","content":[{"$$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":"link","inline":true,"attributes":{"href":"/dash/openapi/Users"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource contains information about a user in Dash such as their email address and their name (if provided)."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/users","summary":"Create a user","prefix":{"name":"post","color":"post"},"badges":[],"link":"/users/postuser","deprecated":false},{"title":"/users/{id}","summary":"Get a user","prefix":{"name":"get","color":"get"},"badges":[],"link":"/users/getuser","deprecated":false},{"title":"/users/{id}","summary":"Update a user","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/users/patchuser","deprecated":false},{"title":"/users/{id}","summary":"Delete a User","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/users/deleteuser","deprecated":false},{"title":"/user-batch-jobs","summary":"Create users","prefix":{"name":"post","color":"post"},"badges":[],"link":"/users/postuserbatchjob","deprecated":false},{"title":"/user-batch-jobs/{id}","summary":"Get the status of creating users","prefix":{"name":"get","color":"get"},"badges":[],"link":"/users/getuserbatchjob","deprecated":false},{"title":"/user-searches","summary":"Search for users","prefix":{"name":"post","color":"post"},"badges":[],"link":"/users/postusersearch","deprecated":false},{"title":"/user-deletes","summary":"Delete a user","prefix":{"name":"post","color":"post"},"badges":[],"link":"/users/postdeleteuser","deprecated":false},{"title":"/current-user","summary":"Get the current user","prefix":{"name":"get","color":"get"},"badges":[],"link":"/users/getcurrentuser","deprecated":false},{"title":"/current-user-creation-status","summary":"Check the creation status of the current user","prefix":{"name":"get","color":"get"},"badges":[],"link":"/users/getcurrentusercreationstatus","deprecated":false},{"title":"/platform/users","summary":"Create a platform user","prefix":{"name":"post","color":"post"},"badges":[],"link":"/users/postplatformuser","deprecated":false},{"title":"/platform/users/{id}","summary":"Patch a platform user","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/users/patchplatformuser","deprecated":false},{"title":"/platform/users/{id}/profile-picture-upload","summary":"Create a platform user profile picture upload","prefix":{"name":"post","color":"post"},"badges":[],"link":"/users/createplatformuserprofilepictureupload","deprecated":false},{"title":"/platform/users/{id}/profile-picture","summary":"Update a platform user profile picture","prefix":{"name":"put","color":"put"},"badges":[],"link":"/users/updateplatformuserprofilepicture","deprecated":false},{"title":"/platform/users/{id}/profile-picture","summary":"Delete a platform user profile picture","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/users/deleteplatformuserprofilepicture","deprecated":false},{"title":"/platform/current-user-account-searches","summary":"Get accounts which the current user has a seat in","prefix":{"name":"post","color":"post"},"badges":[],"link":"/users/postplatformcurrentuseraccountssearch","deprecated":false},{"title":"/platform/user-forgotten-passwords","summary":"Request a password reset","prefix":{"name":"post","color":"post"},"badges":[],"link":"/users/postplatformuserforgottenpassword","deprecated":false},{"title":"/platform/user-reset-passwords","summary":"Reset a password","prefix":{"name":"post","color":"post"},"badges":[],"link":"/users/postplatformuserresetpassword","deprecated":false},{"title":"/platform/user-sign-up-tokens","summary":"Get a sign-up token","prefix":{"name":"post","color":"post"},"badges":[],"link":"/users/postplatformusersignuptoken","deprecated":false},{"title":"/platform/user-verifications","summary":"Request verification code for sign-up","prefix":{"name":"post","color":"post"},"badges":[],"link":"/users/postplatformuserverification","deprecated":false}]}]}]}]}},{"type":"group","label":"User Referrer","link":"/dash/openapi/user-referrer","routeSlug":"/dash/openapi/user-referrer","items":[{"label":"Get the current user's referrer code","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/user-referrer/getcurrentuserreferrer","routeSlug":"/dash/openapi/user-referrer/getcurrentuserreferrer","metadata":{"seo":{"title":"Get the current user's referrer code","description":"Get the currently authenticated User's referrer code"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCurrentUserReferrer","name":"Get the current user's referrer code","isWebhook":false,"pointer":"/paths/~1current-user-referrer/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get the current user's referrer code","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":"Get the currently authenticated "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Users"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'s referrer code"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/current-user-referrer","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","4XX"],"pointer":"/current-user-referrer","href":"user-referrer/getcurrentuserreferrer","openApiOperationId":"getCurrentUserReferrer","summary":"Get the current user's referrer code"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReferrerWithPermittedActions"}},"schemaId":"components/schemas/ReferrerWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1current-user-referrer/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ReferrerWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReferrerWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-referrer/getcurrentuserreferrer"}],"panels":[]}]},"httpPath":"/current-user-referrer"}],"content":{"contentType":"group","meta":{"name":"User Referrer"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"User Referrer","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Coming soon; "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"mailto:help@dash.app"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contact us"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if you need access to this API endpoint."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/current-user-referrer","summary":"Get the current user's referrer code","prefix":{"name":"get","color":"get"},"badges":[],"link":"/user-referrer/getcurrentuserreferrer","deprecated":false}]}]}]}]}},{"type":"group","label":"User Preferences","link":"/dash/openapi/user-preferences","routeSlug":"/dash/openapi/user-preferences","items":[{"label":"Get the current user's preferences","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/user-preferences/getcurrentuserpreferences","routeSlug":"/dash/openapi/user-preferences/getcurrentuserpreferences","metadata":{"seo":{"title":"Get the current user's preferences","description":"Get the currently authenticated User's preferences"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCurrentUserPreferences","name":"Get the current user's preferences","isWebhook":false,"pointer":"/paths/~1current-user-preferences/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get the current user's preferences","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":"Get the currently authenticated "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Users"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'s preferences"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/current-user-preferences","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","4XX"],"pointer":"/current-user-preferences","href":"user-preferences/getcurrentuserpreferences","openApiOperationId":"getCurrentUserPreferences","summary":"Get the current user's preferences"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UserPreferencesWithPermittedActions"}},"schemaId":"components/schemas/UserPreferencesWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1current-user-preferences/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/UserPreferencesWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UserPreferencesWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-preferences/getcurrentuserpreferences"}],"panels":[]}]},"httpPath":"/current-user-preferences"},{"label":"Update the current user's preferences","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dash/openapi/user-preferences/patchcurrentuserpreferences","routeSlug":"/dash/openapi/user-preferences/patchcurrentuserpreferences","metadata":{"seo":{"title":"Update the current user's preferences","description":"Update the currently authenticated User's preferences"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchCurrentUserPreferences","name":"Update the current user's preferences","isWebhook":false,"pointer":"/paths/~1current-user-preferences/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update the current user's preferences","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":"Update the currently authenticated "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Users"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'s preferences"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UserPreferencesPatchRequest"}},"schemaId":"components/schemas/UserPreferencesPatchRequest","pointer":"/paths/~1current-user-preferences/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/current-user-preferences","servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UserPreferencesPatchRequest"}},"responseCodes":["200","4XX"],"pointer":"/current-user-preferences","href":"user-preferences/patchcurrentuserpreferences","openApiOperationId":"patchCurrentUserPreferences","summary":"Update the current user's preferences"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}],"schemaId":"components/schemas/UserPreferencesPatchRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UserPreferencesPatchRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UserPreferencesWithPermittedActions"}},"schemaId":"components/schemas/UserPreferencesWithPermittedActions"},{"code":"4XX","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1current-user-preferences/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/UserPreferencesWithPermittedActions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UserPreferencesWithPermittedActions"}}},{"code":"4XX","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-preferences/patchcurrentuserpreferences"}],"panels":[]}]},"httpPath":"/current-user-preferences"}],"content":{"contentType":"group","meta":{"name":"User Preferences"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"User Preferences","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Coming soon; "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"mailto:help@dash.app"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contact us"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if you need access to this API endpoint."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/current-user-preferences","summary":"Get the current user's preferences","prefix":{"name":"get","color":"get"},"badges":[],"link":"/user-preferences/getcurrentuserpreferences","deprecated":false},{"title":"/current-user-preferences","summary":"Update the current user's preferences","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/user-preferences/patchcurrentuserpreferences","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/DataType":{"id":"components/schemas/DataType","kind":"json-schema","title":"DataType","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the format the data can take"},"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":"STRING: Any format"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DATE: Dates in the ISO date format"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DATE_TIME: Date Times in the ISO datetime format"},"children":[]}]}]}]}],"enum":["STRING","DATE","DATE_TIME"],"example":"STRING"}},"components/schemas/FieldOptionSearchField":{"id":"components/schemas/FieldOptionSearchField","kind":"json-schema","title":"FieldOptionSearchField","data":{"type":"string","enum":["FIELD_ID","PARENT_ID","VALUE","ID","POSITION"],"example":"FIELD_ID","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property value"},"children":[]}]}]}]}},"components/schemas/Field":{"id":"components/schemas/Field","kind":"json-schema","title":"Field","data":{"type":"object","required":["id","accountId","name","dataType","multiValue","hasFixedOptions","hierarchical","editControl","contributorsCanCreateFieldOptions","indestructible","recommended","browsable","entityType","lookupType"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field"},"children":[]}]}]}]}],"example":"a52b5315-15b8-417f-b742-d6902108bac1"},"accountId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" belongs to"},"children":[]}]}]}],"type":"string","example":"cfb665ca-ce35-4418-b9d5-70ee815db4bd"},"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Human-readable name of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field"},"children":[]}]}]}]}],"example":"Folders"},"dataType":{"$ref":"#/components/schemas/DataType"},"multiValue":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be assigned multiple values for this "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field"},"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":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can only be assigned a single value for this "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field"},"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":"e.g. An "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can only have a single "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Title"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" but could be assigned multiple "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":true},"hasFixedOptions":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the possible values for this "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are taken from a fixed set."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the possible values for this "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are unrestricted."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The set of fixed values for an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are defined by the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the values in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset.metadata.values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" map reference an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption.id"},"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":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the values in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset.metadata.values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" map contain the human-readable value."},"children":[]}]}]}],"example":true},"hierarchical":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only applicable when "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field.hasFixedOptions = true"},"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":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the fixed set possible values for the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" form a hierarchical tree structure."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An optional "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption.parent"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" specifies the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of it's parent in the tree."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption.parent = null"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sits at the root of the tree."},"children":[]}]}]}],"example":true},"editControl":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An indication of the type of edit control would be sensible to use to edit the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field"},"children":[]}]}]}]}],"enum":["SINGLE_LINE_TEXT","TEXT_AREA","TAGS","CONTROLLED_TAGS","DROPDOWN","CHECKLIST","FOLDER_PICKER","PRODUCT_PICKER","DATE_PICKER","DATE_TIME_PICKER","EXPIRY_DATE_PICKER","RELEASE_DATE_PICKER","RATING"],"example":"FOLDER_PICKER"},"contributorsCanCreateFieldOptions":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", admins and contributors can create "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources for this "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field"},"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":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" creation uses the existing folder-specific permission logic."},"children":[]}]}]}],"example":true},"indestructible":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cannot be deleted. Primarily used to prevent removal of an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" which is required by Dash."},"children":[]}]}]}],"example":true},"recommended":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" it is recommended for assets to have a value for this "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field"},"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":"Clients should highlight missing recommended values during creation and editing of assets."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Clients can also use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FIELD_IS_EMPTY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" criterion in an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/postassetsearch"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetSearch"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to find assets with missing recommended values."},"children":[]}]}]}],"example":true},"defaultSortField":{"nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The sort to use when searching for "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/FieldOptions"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"s related to this "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if no sort is provided."},"children":[]}]}]}],"$ref":"#/components/schemas/FieldOptionSearchField"},"browsable":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" assets with a value for this "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be browsed in the Browse page."},"children":[]}]}]}],"example":true},"entityType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The entity type this "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" stores values for."},"children":[]}]}]}],"enum":["ASSET","PRODUCT","PRODUCT_VARIANT"],"example":"ASSET"},"lookupType":{"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 lookup type of this "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or null if this is not a lookup field"},"children":[]}]}]}],"enum":["PRODUCT_VARIANT_CRITERION"],"example":"PRODUCT_VARIANT_CRITERION"}}}},"components/schemas/ResourceType":{"id":"components/schemas/ResourceType","kind":"json-schema","title":"ResourceType","data":{"type":"string","description":"Defines the type of the resource that is being permitted to act on","enum":["ACCOUNT","ALLOWED_LOGIN_METHODS","ASSET","ASSET_METADATA","ASSET_SHARE","ASSET_SHARES","ASSETS","ASSETS_IN_NO_FOLDERS","ATTRIBUTE_OPTION","ATTRIBUTE_OPTIONS","ATTRIBUTE_VIEWS","ATTRIBUTES","CANVA_INTEGRATION","CLOUD_CONNECTION","CLOUD_CONNECTIONS","COLLECTION","COLLECTION_SHARE","COLLECTIONS","COMMENT","COREBOOK_INTEGRATION","CUSTOM_TERMS_AND_CONDITIONS","EMAILS","FIELD_OPTION","FIELD_OPTIONS","FIELD_VIEWS","FIELDS","GUEST_UPLOAD","GUEST_UPLOAD_USERS","GUEST_UPLOADS","HOOTSUITE_INTEGRATION","INDESIGN_EXTENSION","INTELLIGENCE_SETTINGS","KLAVIYO_INTEGRATION","METADATA_SCHEMA","PARENT_ATTRIBUTE_OPTIONS","PARENT_FIELD_OPTIONS","PORTAL","PORTALS","PRESET_SIZES","REFERRAL","SAVED_CROP_AREA","SAVED_CROP_AREAS","SAVED_SEARCH","SAVED_SEARCHES","SEARCH_FILTER","SHOPIFY_INTEGRATION_V2","SUBSCRIPTION","THEME","TOP_LEVEL_ATTRIBUTE_OPTIONS","TOP_LEVEL_FIELD_OPTIONS","USER","USER_GROUPS","USER_JOB","USER_JOBS","USERS","WEB_USAGE","WORDPRESS_INTEGRATION"],"example":"ASSET"}},"components/schemas/ActionType":{"id":"components/schemas/ActionType","kind":"json-schema","title":"ActionType","data":{"type":"string","description":"Defines the action that is being permitted","enum":["ADD_ASSET_TO_COLLECTION","ADD_COLLABORATOR_TO_COLLECTION","APPROVE_ASSETS","CONFIGURE_KLAVIYO_INTEGRATION","CONFIGURE_SHOPIFY_INTEGRATION","CREATE_ASSET_SHARES","CREATE_ASSETS","CREATE_CHILD_ATTRIBUTE_OPTIONS","CREATE_CHILD_FIELD_OPTIONS","CREATE_CLOUD_CONNECTIONS","CREATE_COLLECTION_COMMENTS","CREATE_COLLECTIONS","CREATE_COMMENTS","CREATE_EMBEDDABLE_LINKS","CREATE_GUEST_UPLOAD_USERS","CREATE_GUEST_UPLOADS","CREATE_PORTALS","CREATE_SAVED_CROP_AREAS","CREATE_SAVED_SEARCHES","CREATE_SUBSCRIPTION","CREATE_TOP_LEVEL_ATTRIBUTE_OPTIONS","CREATE_TOP_LEVEL_FIELD_OPTIONS","CUSTOMISE_EMAILS","DELETE_ASSET","DELETE_ASSET_FILES","DELETE_ASSET_SHARE","DELETE_CLOUD_CONNECTION","DELETE_COLLECTION","DELETE_COMMENT","DELETE_GUEST_UPLOAD","DELETE_JOB","DELETE_PORTAL","DELETE_SAVED_CROP_AREA","DELETE_SAVED_SEARCH","DOWNLOAD_ASSET","DOWNLOAD_INDESIGN_EXTENSION","EDIT_ACCOUNT","EDIT_ALLOWED_LOGIN_METHODS","EDIT_ASSET","EDIT_ASSET_SHARE","EDIT_ATTRIBUTE_OPTION","EDIT_ATTRIBUTE_OPTION_IMAGE","EDIT_ATTRIBUTES","EDIT_CLOUD_CONNECTION","EDIT_COLLECTION","EDIT_COMMENT","EDIT_FIELD_OPTION","EDIT_FIELD_OPTION_IMAGE","EDIT_FIELDS","EDIT_GUEST_UPLOAD","EDIT_INTELLIGENCE_SETTINGS_ADDRESS_LOOKUP","EDIT_INTELLIGENCE_SETTINGS_IMAGE_AUTO_TAGGING","EDIT_INTELLIGENCE_SETTINGS_IMAGE_FACIAL_REC","EDIT_INTELLIGENCE_SETTINGS_TEXT_IN_IMAGE","EDIT_INTELLIGENCE_SETTINGS_VIDEO_AUTO_TAGGING","EDIT_INTELLIGENCE_SETTINGS_VIDEO_FACIAL_REC","EDIT_METADATA_SCHEMA","EDIT_PORTAL","EDIT_PRESET_SIZES","EDIT_SAVED_CROP_AREA","EDIT_SAVED_SEARCH","EDIT_SEAT","EDIT_THEME","EDIT_USER_GROUPS","EXPORT_TO_KLAVIYO","EXPORT_TO_SHOPIFY","GENERATE_IMAGE_EMBEDDINGS","IMPORT_ASSETS_OR_METADATA","IMPORT_FROM_CLOUD","MAKE_REFERRAL","MANAGE_CUSTOM_TERMS_AND_CONDITIONS","PROMOTE_ASSETS_TO_LIVE","PUT_ASSETS_IN_NO_FOLDER","REMOVE_ASSET_FROM_COLLECTION","REMOVE_COLLABORATOR_FROM_COLLECTION","RESTART_JOB","RUN_EXACT_KNN_SEARCH","RUN_NATURAL_LANGUAGE_SEARCH","SCROLL","SEARCH_FOR_CHANGE_LIFECYCLE_STATE_TO_BINNED","SEARCH_FOR_CHANGE_LIFECYCLE_STATE_TO_LIVE","SEARCH_FOR_CHANGE_LIFECYCLE_STATE_TO_PENDING_APPROVAL","SEARCH_FOR_CHANGE_STAGING_STATE_TO_LIVE","SEARCH_FOR_CHANGE_STAGING_STATE_TO_PENDING_APPROVAL","SEARCH_FOR_DELETE","SEARCH_FOR_DOWNLOAD","SEARCH_FOR_EDIT","SEARCH_FOR_PROMOTE_TO_LIVE","SEARCH_FOR_SEND_FOR_APPROVAL","SEARCH_FOR_VIEW","SET_ASSETS_LIFECYCLE_STATUS_BINNED","SET_ASSETS_LIFECYCLE_STATUS_LIVE","SET_ASSETS_STAGING_STATUS_LIVE","STOP_JOB","UPDATE_METADATA_WITH_ATTRIBUTE_OPTION","UPDATE_METADATA_WITH_FIELD_OPTION","USE_CANVA_INTEGRATION","USE_CLOUD_CONNECTION","USE_COLLECTIONS","USE_COREBOOK_INTEGRATION","USE_EMBEDDABLE_LINKS","USE_HOOTSUITE_INTEGRATION","USE_WORDPRESS_INTEGRATION","VIEW_ACCOUNT","VIEW_ASSET","VIEW_ASSET_EVENTS","VIEW_ASSET_EVENTS_COUNTS","VIEW_ASSET_FACES","VIEW_ASSET_FILES","VIEW_ASSET_METADATA","VIEW_ASSET_SHARE","VIEW_ASSETS_IN_NO_FOLDER","VIEW_ATTRIBUTE_OPTION","VIEW_ATTRIBUTE_OPTION_IMAGE","VIEW_ATTRIBUTE_OPTIONS","VIEW_ATTRIBUTE_VIEWS","VIEW_CLOUD_CONNECTION","VIEW_COLLECTION","VIEW_COLLECTION_SHARE","VIEW_COMMENTS","VIEW_FIELD_OPTION","VIEW_FIELD_OPTION_IMAGE","VIEW_FIELD_OPTIONS","VIEW_FIELD_VIEWS","VIEW_GUEST_UPLOAD","VIEW_JOB","VIEW_JOBS","VIEW_METADATA_SUGGESTIONS","VIEW_PORTAL","VIEW_PORTALS","VIEW_PRESET_SIZES","VIEW_SAVED_CROP_AREA","VIEW_SAVED_CROP_AREAS","VIEW_SAVED_SEARCH","VIEW_SEARCH_FILTER","VIEW_SEAT","VIEW_SIMILAR_ASSETS","VIEW_USERS","VIEW_WEB_USAGE"],"example":"VIEW_ASSET"}},"components/schemas/PermittedAction":{"id":"components/schemas/PermittedAction","kind":"json-schema","title":"PermittedAction","data":{"type":"object","required":["resourceType","action"],"properties":{"resourceType":{"$ref":"#/components/schemas/ResourceType"},"resourceId":{"type":"string","nullable":true,"description":"The ID of the resource that is being permitted to act on.  This may be null if the permission is on the resource type as a whole rather than an individual instance.","example":"7af90a8b-7ccd-430f-a85d-e8614015bc47"},"action":{"$ref":"#/components/schemas/ActionType"}}}},"components/schemas/FieldWithPermittedActions":{"id":"components/schemas/FieldWithPermittedActions","kind":"json-schema","title":"FieldWithPermittedActions","data":{"type":"object","required":["result","permittedActions"],"properties":{"result":{"$ref":"#/components/schemas/Field"},"permittedActions":{"type":"array","items":{"$ref":"#/components/schemas/PermittedAction"}}}}},"components/schemas/Error":{"id":"components/schemas/Error","kind":"json-schema","title":"Error","data":{"type":"object","properties":{"timestamp":{"type":"string","description":"The datetime that the error occurred in ISO offset format","format":"date-time","example":"2021-02-16T16:21:58.640+00:00"},"status":{"type":"integer","description":"The HTTP status code of the error","example":401},"error":{"type":"string","description":"The title of the error","example":"Unauthorized"},"message":{"type":"string","description":"A more detailed error message","nullable":true,"example":null},"path":{"type":"string","description":"The path that was called which led to the error","example":"/folder-settings"}}}},"components/schemas/FieldRequest":{"id":"components/schemas/FieldRequest","kind":"json-schema","title":"FieldRequest","data":{"type":"object","required":["name","dataType","multiValue","hasFixedOptions","hierarchical","editControl","recommended","browsable"],"properties":{"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Human-readable name of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field"},"children":[]}]}]}]}],"example":"Folders"},"dataType":{"$ref":"#/components/schemas/DataType"},"multiValue":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be assigned multiple values for this "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field"},"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":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can only be assigned a single value for this "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field"},"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":"e.g. An "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can only have a single "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Title"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" but could be assigned multiple "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":true},"hasFixedOptions":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the possible values for this "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are taken from a fixed set."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the possible values for this "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are unrestricted."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The set of fixed values for an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are defined by the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the values in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset.metadata.values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" map reference an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption.id"},"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":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the values in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset.metadata.values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" map contain the human-readable value."},"children":[]}]}]}],"example":true},"hierarchical":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only applicable when "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field.hasFixedOptions = true"},"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":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the fixed set possible values for the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" form a hierarchical tree structure."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An optional "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption.parent"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" specifies the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of it's parent in the tree."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption.parent = null"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sits at the root of the tree."},"children":[]}]}]}],"example":true},"editControl":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An indication of the type of edit control would be sensible to use to edit the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field"},"children":[]}]}]}]}],"enum":["SINGLE_LINE_TEXT","TEXT_AREA","TAGS","CONTROLLED_TAGS","DROPDOWN","CHECKLIST","FOLDER_PICKER","PRODUCT_PICKER","DATE_PICKER","DATE_TIME_PICKER","EXPIRY_DATE_PICKER","RELEASE_DATE_PICKER","RATING"],"example":"FOLDER_PICKER"},"contributorsCanCreateFieldOptions":{"type":"boolean","default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", admins and contributors can create "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources for this "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field"},"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":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" creation uses the existing folder-specific permission logic."},"children":[]}]}]}],"example":true},"recommended":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" it is recommended for assets to have a value for this "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field"},"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":"Clients should highlight missing recommended values during creation and editing of assets."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Clients can also use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FIELD_IS_EMPTY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" criterion in an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/postassetsearch"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetSearch"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to find assets with missing recommended values."},"children":[]}]}]}],"example":true},"defaultSortField":{"nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The sort to use when searching for "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/FieldOptions"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"s related to this "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if no sort is provided."},"children":[]}]}]}],"$ref":"#/components/schemas/FieldOptionSearchField"},"browsable":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" assets with a value for this "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be browsed in the Browse page."},"children":[]}]}]}],"example":true}}}},"components/schemas/NullableFieldOptionSearchFieldPatch":{"id":"components/schemas/NullableFieldOptionSearchFieldPatch","kind":"json-schema","title":"NullableFieldOptionSearchFieldPatch","data":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/FieldOptionSearchField"}}}},"components/schemas/FieldPatchRequest":{"id":"components/schemas/FieldPatchRequest","kind":"json-schema","title":"FieldPatchRequest","data":{"type":"object","properties":{"name":{"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":"Human-readable name of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field"},"children":[]}]}]}]}],"example":"Folders"},"contributorsCanCreateFieldOptions":{"type":"boolean","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", admins and contributors can create "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources for this "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field"},"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":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" creation uses the existing folder-specific permission logic."},"children":[]}]}]}],"example":true},"recommended":{"type":"boolean","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" it is recommended for assets to have a value for this "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field"},"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":"Clients should highlight missing recommended values during creation and editing of assets."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Clients can also use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FIELD_IS_EMPTY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" criterion in an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/postassetsearch"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetSearch"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to find assets with missing recommended values."},"children":[]}]}]}],"example":true},"defaultSortField":{"nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The sort to use when searching for "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/FieldOptions"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"s related to this "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if no sort is provided."},"children":[]}]}]}],"$ref":"#/components/schemas/NullableFieldOptionSearchFieldPatch"},"browsable":{"type":"boolean","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether assets with a value for this "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be browsed in the Browse page. Note that this option cannot be changed for Folder fields or non-fixed-option fields."},"children":[]}]}]}],"example":false}}}},"components/schemas/FieldOptionRequest":{"id":"components/schemas/FieldOptionRequest","kind":"json-schema","title":"FieldOptionRequest","data":{"type":"object","required":["fieldId","value"],"properties":{"fieldId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" should belong to"},"children":[]}]}]}],"example":"a52b5315-15b8-417f-b742-d6902108bac1"},"value":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The human-readable value of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption"},"children":[]}]}]}]}],"example":"Folder A"},"position":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The 0-based position the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" should occupy relative to the other options"},"children":[]}]}]}],"default":0,"example":2},"parentId":{"description":[{"$$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":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption.id"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the option above this one in the hierarchy"},"children":[]}]}]}],"type":"string","nullable":true,"default":null}}}},"components/schemas/FieldOptionWithPermittedActions":{"id":"components/schemas/FieldOptionWithPermittedActions","kind":"json-schema","title":"FieldOptionWithPermittedActions","data":{"type":"object","required":["result","permittedActions"],"properties":{"result":{"$ref":"#/components/schemas/FieldOption"},"permittedActions":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permitted actions for "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources:"},"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":"FIELD_OPTION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" : "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UPDATE_METADATA_WITH_FIELD_OPTION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Whether the user can assign this "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as a value in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset.metadata.values"},"children":[]}]}]}]}]}],"items":{"$ref":"#/components/schemas/PermittedAction"}}}}},"components/schemas/FieldOption":{"id":"components/schemas/FieldOption","kind":"json-schema","title":"FieldOption","data":{"type":"object","required":["id","value","fieldId","position","leaf","numberOfChildren","numberOfDescendants"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID for the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption"},"children":[]}]}]}]}],"example":"1fc6d6c3-c42d-48e2-b0db-5d680a58ca52"},"value":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The human-readable value of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption"},"children":[]}]}]}]}],"example":"Folder A"},"fieldId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" belongs to"},"children":[]}]}]}],"example":"a52b5315-15b8-417f-b742-d6902108bac1"},"position":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The 0-based position the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has in realtion to other options for the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field"},"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":"If "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field.hierarchical = true"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" this position related to other options with the same "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption.parent"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":2},"leaf":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field.hierarchical = true"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" whether this field option is a leaf node i.e. has no children."},"children":[]}]}]}],"example":true},"numberOfChildren":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field.hierarchical = true"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the number of children this field option has."},"children":[]}]}]}],"example":0},"numberOfDescendants":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field.hierarchical = true"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the number of descendants (e.g. children, grandchildren, great-grandchildren, etc) this field option has."},"children":[]}]}]}],"example":0},"parent":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field.hierarchical = true"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that this "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a child of"},"children":[]}]}]}],"nullable":true,"allOf":[{"$ref":"#/components/schemas/FieldOptionWithPermittedActions"}]}}}},"components/schemas/BatchItem":{"id":"components/schemas/BatchItem","kind":"json-schema","title":"BatchItem","data":{"type":"object","required":["batchItemId"],"properties":{"batchItemId":{"type":"string","description":"An ID provided by the caller to uniquely identify this item in the batch request\nThis is will be used to match the relevant results in the batch result\n","example":"my-item-1"}}}},"components/schemas/FieldOptionBatchRequestItem":{"id":"components/schemas/FieldOptionBatchRequestItem","kind":"json-schema","title":"FieldOptionBatchRequestItem","data":{"allOf":[{"$ref":"#/components/schemas/BatchItem"},{"$ref":"#/components/schemas/FieldOptionRequest"}]}},"components/schemas/FieldOptionBatchRequest":{"id":"components/schemas/FieldOptionBatchRequest","kind":"json-schema","title":"FieldOptionBatchRequest","data":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/FieldOptionBatchRequestItem"}}}}},"components/schemas/FieldOptionFailure":{"id":"components/schemas/FieldOptionFailure","kind":"json-schema","title":"FieldOptionFailure","data":{"type":"string","enum":["OPTION_ALREADY_EXISTS_AT_THIS_LEVEL","PARENT_DOES_NOT_EXIST","FIELD_DOES_NOT_EXIST"]}},"components/schemas/FieldOptionBatch":{"id":"components/schemas/FieldOptionBatch","kind":"json-schema","title":"FieldOptionBatch","data":{"type":"object","required":["successes","failures"],"properties":{"successes":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A map of successful results keyed on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"batchItemId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" provided in the request"},"children":[]}]}]}],"additionalProperties":{"$ref":"#/components/schemas/FieldOptionWithPermittedActions"}},"failures":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A map of failures keyed on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"batchItemId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" provided in the request"},"children":[]}]}]}],"additionalProperties":{"$ref":"#/components/schemas/FieldOptionFailure"}}}}},"components/schemas/BasePaginatedSearchInAccountRequest":{"id":"components/schemas/BasePaginatedSearchInAccountRequest","kind":"json-schema","title":"BasePaginatedSearchInAccountRequest","data":{"type":"object","required":["from","pageSize"],"properties":{"from":{"description":"The item number to begin the result set from","type":"integer","example":0,"default":0},"pageSize":{"description":"The maximum number of items to return in the result set.","type":"integer","minimum":0,"maximum":1000,"example":100,"default":100}}}},"components/schemas/SearchCriterion":{"id":"components/schemas/SearchCriterion","kind":"json-schema","title":"SearchCriterion","data":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}}}},"components/schemas/FieldEqualsSearchCriterion":{"id":"components/schemas/FieldEqualsSearchCriterion","kind":"json-schema","title":"FieldEqualsSearchCriterion","data":{"allOf":[{"$ref":"#/components/schemas/SearchCriterion"},{"type":"object","required":["value"],"properties":{"value":{"type":"string","description":"The value to check equality against","example":"Folder"}}}]}},"components/schemas/FieldOptionFieldEqualsSearchCriterion":{"id":"components/schemas/FieldOptionFieldEqualsSearchCriterion","kind":"json-schema","title":"FieldOptionFieldEqualsSearchCriterion","data":{"allOf":[{"$ref":"#/components/schemas/FieldEqualsSearchCriterion"},{"type":"object","required":["type","field"],"properties":{"type":{"type":"string","enum":["FIELD_EQUALS"]},"field":{"$ref":"#/components/schemas/FieldOptionSearchField"}}}]}},"components/schemas/FieldContainsSearchCriterion":{"id":"components/schemas/FieldContainsSearchCriterion","kind":"json-schema","title":"FieldContainsSearchCriterion","data":{"allOf":[{"$ref":"#/components/schemas/SearchCriterion"},{"type":"object","required":["value"],"properties":{"value":{"type":"string","description":"The value to check whether the field contains","example":"older"}}}]}},"components/schemas/FieldOptionFieldContainsSearchCriterion":{"id":"components/schemas/FieldOptionFieldContainsSearchCriterion","kind":"json-schema","title":"FieldOptionFieldContainsSearchCriterion","data":{"allOf":[{"$ref":"#/components/schemas/FieldContainsSearchCriterion"},{"type":"object","required":["type","field"],"properties":{"type":{"type":"string","enum":["FIELD_CONTAINS"]},"field":{"$ref":"#/components/schemas/FieldOptionSearchField"}}}]}},"components/schemas/FieldInSearchCriterion":{"id":"components/schemas/FieldInSearchCriterion","kind":"json-schema","title":"FieldInSearchCriterion","data":{"allOf":[{"$ref":"#/components/schemas/SearchCriterion"},{"type":"object","required":["values"],"properties":{"values":{"type":"array","items":{"type":"string"},"description":"The values to check equality against the field values","example":["this","that"]}}}]}},"components/schemas/FieldOptionFieldInSearchCriterion":{"id":"components/schemas/FieldOptionFieldInSearchCriterion","kind":"json-schema","title":"FieldOptionFieldInSearchCriterion","data":{"allOf":[{"$ref":"#/components/schemas/FieldInSearchCriterion"},{"type":"object","required":["type","values"],"properties":{"type":{"type":"string","enum":["FIELD_IN"]},"field":{"$ref":"#/components/schemas/FieldOptionSearchField"}}}]}},"components/schemas/FieldIsEmptySearchCriterion":{"id":"components/schemas/FieldIsEmptySearchCriterion","kind":"json-schema","title":"FieldIsEmptySearchCriterion","data":{"allOf":[{"$ref":"#/components/schemas/SearchCriterion"},{"type":"object"}]}},"components/schemas/FieldOptionFieldIsEmptySearchCriterion":{"id":"components/schemas/FieldOptionFieldIsEmptySearchCriterion","kind":"json-schema","title":"FieldOptionFieldIsEmptySearchCriterion","data":{"allOf":[{"$ref":"#/components/schemas/FieldIsEmptySearchCriterion"},{"type":"object","required":["type","field"],"properties":{"type":{"type":"string","enum":["FIELD_IS_EMPTY"]},"field":{"$ref":"#/components/schemas/FieldOptionSearchField"}}}]}},"components/schemas/MatchAllSearchCriterion":{"id":"components/schemas/MatchAllSearchCriterion","kind":"json-schema","title":"MatchAllSearchCriterion","data":{"allOf":[{"$ref":"#/components/schemas/SearchCriterion"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["MATCH_ALL"]}}}]}},"components/schemas/FieldOptionSearchCriterion":{"id":"components/schemas/FieldOptionSearchCriterion","kind":"json-schema","title":"FieldOptionSearchCriterion","data":{"oneOf":[{"$ref":"#/components/schemas/FieldOptionFieldEqualsSearchCriterion"},{"$ref":"#/components/schemas/FieldOptionFieldContainsSearchCriterion"},{"$ref":"#/components/schemas/FieldOptionFieldInSearchCriterion"},{"$ref":"#/components/schemas/FieldOptionFieldIsEmptySearchCriterion"},{"$ref":"#/components/schemas/MatchAllSearchCriterion"},{"$ref":"#/components/schemas/FieldOptionAndSearchCriterion"},{"$ref":"#/components/schemas/FieldOptionOrSearchCriterion"},{"$ref":"#/components/schemas/FieldOptionNotSearchCriterion"}],"discriminator":{"propertyName":"type","mapping":{"FIELD_EQUALS":"#/components/schemas/FieldOptionFieldEqualsSearchCriterion","FIELD_CONTAINS":"#/components/schemas/FieldOptionFieldContainsSearchCriterion","FIELD_IN":"#/components/schemas/FieldOptionFieldInSearchCriterion","FIELD_IS_EMPTY":"#/components/schemas/FieldOptionFieldIsEmptySearchCriterion","MATCH_ALL":"#/components/schemas/MatchAllSearchCriterion","AND":"#/components/schemas/FieldOptionAndSearchCriterion","OR":"#/components/schemas/FieldOptionOrSearchCriterion","NOT":"#/components/schemas/FieldOptionNotSearchCriterion"}}}},"components/schemas/FieldOptionAndSearchCriterion":{"id":"components/schemas/FieldOptionAndSearchCriterion","kind":"json-schema","title":"FieldOptionAndSearchCriterion","data":{"allOf":[{"$ref":"#/components/schemas/SearchCriterion"},{"type":"object","required":["type","criteria"],"properties":{"type":{"type":"string","enum":["AND"]},"criteria":{"type":"array","description":"The list of criteria to AND together","items":{"$ref":"#/components/schemas/FieldOptionSearchCriterion"}}}}]}},"components/schemas/FieldOptionOrSearchCriterion":{"id":"components/schemas/FieldOptionOrSearchCriterion","kind":"json-schema","title":"FieldOptionOrSearchCriterion","data":{"allOf":[{"$ref":"#/components/schemas/SearchCriterion"},{"type":"object","required":["type","criteria"],"properties":{"type":{"type":"string","enum":["OR"]},"criteria":{"type":"array","description":"The list of criteria to OR together","items":{"$ref":"#/components/schemas/FieldOptionSearchCriterion"}}}}]}},"components/schemas/FieldOptionNotSearchCriterion":{"id":"components/schemas/FieldOptionNotSearchCriterion","kind":"json-schema","title":"FieldOptionNotSearchCriterion","data":{"allOf":[{"$ref":"#/components/schemas/SearchCriterion"},{"type":"object","required":["type","criterion"],"properties":{"type":{"type":"string","enum":["NOT"]},"criterion":{"description":"The criterion to negate","$ref":"#/components/schemas/FieldOptionSearchCriterion"}}}]}},"components/schemas/SortOrder":{"id":"components/schemas/SortOrder","kind":"json-schema","title":"SortOrder","data":{"type":"string","description":"The order of the sort","enum":["ASC","DESC"]}},"components/schemas/FieldOptionSort":{"id":"components/schemas/FieldOptionSort","kind":"json-schema","title":"FieldOptionSort","data":{"type":"object","required":["field","order"],"properties":{"field":{"$ref":"#/components/schemas/FieldOptionSearchField"},"order":{"$ref":"#/components/schemas/SortOrder"}}}},"components/schemas/FieldOptionSearchRequest":{"id":"components/schemas/FieldOptionSearchRequest","kind":"json-schema","title":"FieldOptionSearchRequest","data":{"allOf":[{"$ref":"#/components/schemas/BasePaginatedSearchInAccountRequest"},{"type":"object","required":["criterion","sorts"],"properties":{"criterion":{"description":"The search criterion","$ref":"#/components/schemas/FieldOptionSearchCriterion"},"sorts":{"description":"Sorts to be applied to the search in order of precedence","type":"array","items":{"$ref":"#/components/schemas/FieldOptionSort"}}}}]}},"components/schemas/FieldOptionSearch":{"id":"components/schemas/FieldOptionSearch","kind":"json-schema","title":"FieldOptionSearch","data":{"type":"object","required":["results","totalResults"],"properties":{"results":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The specified page of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources  which match the search criterion"},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/FieldOptionWithPermittedActions"}},"totalResults":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total number of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources which match the search criterion"},"children":[]}]}]}],"example":1337}}}},"components/schemas/FieldOptionImageRequest":{"id":"components/schemas/FieldOptionImageRequest","kind":"json-schema","title":"FieldOptionImageRequest","data":{"type":"object","required":["fieldOptionId"],"properties":{"fieldOptionId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Option-Images"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOptionImage"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" belongs to"},"children":[]}]}]}],"example":"a52b5315-15b8-417f-b742-d6902108bac1"}}}},"components/schemas/FieldOptionImageBatchRequestItem":{"id":"components/schemas/FieldOptionImageBatchRequestItem","kind":"json-schema","title":"FieldOptionImageBatchRequestItem","data":{"allOf":[{"$ref":"#/components/schemas/BatchItem"},{"$ref":"#/components/schemas/FieldOptionImageRequest"}]}},"components/schemas/FieldOptionImageBatchRequest":{"id":"components/schemas/FieldOptionImageBatchRequest","kind":"json-schema","title":"FieldOptionImageBatchRequest","data":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/FieldOptionImageBatchRequestItem"}}}}},"components/schemas/FieldOptionImage":{"id":"components/schemas/FieldOptionImage","kind":"json-schema","title":"FieldOptionImage","data":{"type":"object","required":["accountId","fieldId","fieldOptionId","url"],"properties":{"accountId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" belongs to"},"children":[]}]}]}],"type":"string","example":"cfb665ca-ce35-4418-b9d5-70ee815db4bd"},"fieldId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" belongs to"},"children":[]}]}]}],"type":"string","example":"7756d388-110c-4712-b350-0b2b48e156c1"},"fieldOptionId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with this image"},"children":[]}]}]}],"type":"string","example":"1fc6d6c3-c42d-48e2-b0db-5d680a58ca52"},"url":{"description":"The signed URL of the image","type":"string","example":"https://example.com"}}}},"components/schemas/FieldOptionImageWithPermittedActions":{"id":"components/schemas/FieldOptionImageWithPermittedActions","kind":"json-schema","title":"FieldOptionImageWithPermittedActions","data":{"type":"object","required":["result","permittedActions"],"properties":{"result":{"$ref":"#/components/schemas/FieldOptionImage"},"permittedActions":{"type":"array","items":{"$ref":"#/components/schemas/PermittedAction"}}}}},"components/schemas/FieldOptionImageFailure":{"id":"components/schemas/FieldOptionImageFailure","kind":"json-schema","title":"FieldOptionImageFailure","data":{"type":"string","enum":["FIELD_OPTION_IMAGE_DOES_NOT_EXIST"]}},"components/schemas/FieldOptionImageBatch":{"id":"components/schemas/FieldOptionImageBatch","kind":"json-schema","title":"FieldOptionImageBatch","data":{"type":"object","required":["successes","failures"],"properties":{"successes":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A map of successful results keyed on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"batchItemId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" provided in the request"},"children":[]}]}]}],"additionalProperties":{"$ref":"#/components/schemas/FieldOptionImageWithPermittedActions"}},"failures":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A map of failues keyed on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"batchItemId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" provided in the request"},"children":[]}]}]}],"additionalProperties":{"$ref":"#/components/schemas/FieldOptionImageFailure"}}}}},"components/schemas/FieldOptionImageUploadRequest":{"id":"components/schemas/FieldOptionImageUploadRequest","kind":"json-schema","title":"FieldOptionImageUploadRequest","data":{"type":"object","required":["accountId","fieldId","fieldOptionId"],"properties":{"accountId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" belongs to"},"children":[]}]}]}],"type":"string","example":"cfb665ca-ce35-4418-b9d5-70ee815db4bd"},"fieldId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" belongs to"},"children":[]}]}]}],"type":"string","example":"7756d388-110c-4712-b350-0b2b48e156c1"},"fieldOptionId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" you would like to upload an image for"},"children":[]}]}]}],"type":"string","example":"1fc6d6c3-c42d-48ue2-b0db-5d680a58ca52"}}}},"components/schemas/FieldOptionImageUpload":{"id":"components/schemas/FieldOptionImageUpload","kind":"json-schema","title":"FieldOptionImageUpload","data":{"type":"object","required":["url"],"properties":{"url":{"description":"The URL that can be used to upload an image","type":"string","example":"https://example.com"}}}},"components/schemas/FieldView":{"id":"components/schemas/FieldView","kind":"json-schema","title":"FieldView","data":{"type":"object","required":["id","accountId","type","fields"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Views"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldView"},"children":[]}]}]}]}],"example":"e9a367e4-8216-497f-b6a9-59e3b945a7f3"},"accountId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" belongs to"},"children":[]}]}]}],"type":"string","example":"cfb665ca-ce35-4418-b9d5-70ee815db4bd"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The context in which to use this "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Views"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldView"},"children":[]}]}]}]}],"enum":["INTERNAL_SUMMARY","INTERNAL_DETAILED","EXTERNAL_SUMMARY","EXTERNAL_DETAILED"],"example":"INTERNAL_DETAILED"},"fields":{"type":"array","items":{"$ref":"#/components/schemas/Field"}}}}},"components/schemas/FieldViewWithPermittedActions":{"id":"components/schemas/FieldViewWithPermittedActions","kind":"json-schema","title":"FieldViewWithPermittedActions","data":{"type":"object","required":["result","permittedActions"],"properties":{"result":{"$ref":"#/components/schemas/FieldView"},"permittedActions":{"type":"array","items":{"$ref":"#/components/schemas/PermittedAction"}}}}},"components/schemas/LifecycleStatusStaged":{"id":"components/schemas/LifecycleStatusStaged","kind":"json-schema","title":"LifecycleStatusStaged","data":{"type":"object","required":["state","dateStaged","stagedBy","stagedBatchPosition"],"properties":{"state":{"type":"string","enum":["STAGED"]},"dateStaged":{"type":"string","format":"date-time","description":"The datetime the asset was staged in ISO datetime format","example":"2021-02-15T09:24:01.417Z"},"stagedBy":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Users"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" who staged the asset"},"children":[]}]}]}],"example":"google-oauth2|110457667287511486432"},"stagedBatchPosition":{"type":"number","description":"The position of the asset within the batch of assets that it was staged with","example":0}}}},"components/schemas/LifecycleStatusPendingApproval":{"id":"components/schemas/LifecycleStatusPendingApproval","kind":"json-schema","title":"LifecycleStatusPendingApproval","data":{"type":"object","required":["state","dateStaged","stagedBy","stagedBatchPosition","datePendingApproval","pendingApprovalBy"],"properties":{"state":{"type":"string","enum":["PENDING_APPROVAL"]},"dateStaged":{"type":"string","format":"date-time","description":"The datetime the asset was staged in ISO datetime format","example":"2021-02-15T09:24:01.417Z"},"stagedBy":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Users"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" who staged the asset"},"children":[]}]}]}],"example":"google-oauth2|110457667287511486432"},"stagedBatchPosition":{"type":"number","description":"The position of the asset within the batch of assets that it was staged with","example":0},"datePendingApproval":{"type":"string","format":"date-time","description":"The datetime the asset was moved to pending approval in ISO datetime format","example":"2021-02-15T09:24:01.417Z"},"pendingApprovalBy":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Users"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" who moved the asset to pending approval"},"children":[]}]}]}],"example":"google-oauth2|110457667287511486432"}}}},"components/schemas/LifecycleStatusLive":{"id":"components/schemas/LifecycleStatusLive","kind":"json-schema","title":"LifecycleStatusLive","data":{"type":"object","required":["state","dateStaged","stagedBy","stagedBatchPosition","dateLive","liveBy"],"properties":{"state":{"type":"string","enum":["LIVE"]},"dateStaged":{"type":"string","format":"date-time","description":"The datetime the asset was staged in ISO datetime format","example":"2021-02-15T09:24:01.417Z"},"stagedBy":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Users"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" who staged the asset"},"children":[]}]}]}],"example":"google-oauth2|110457667287511486432"},"stagedBatchPosition":{"type":"number","description":"The position of the asset within the batch of assets that it was staged with","example":0},"datePendingApproval":{"type":"string","nullable":true,"format":"date-time","description":"The datetime the asset was moved to pending approval in ISO datetime format","example":"2021-02-15T09:24:01.417Z"},"pendingApprovalBy":{"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 ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Users"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" who moved the asset to pending approval"},"children":[]}]}]}],"example":"google-oauth2|110457667287511486432"},"dateLive":{"type":"string","format":"date-time","description":"The datetime the asset was moved to live in ISO datetime format","example":"2021-02-15T09:24:01.417Z"},"liveBy":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Users"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" who moved the asset to live"},"children":[]}]}]}],"example":"google-oauth2|110457667287511486432"}}}},"components/schemas/LifecycleStatusBinned":{"id":"components/schemas/LifecycleStatusBinned","kind":"json-schema","title":"LifecycleStatusBinned","data":{"type":"object","required":["state","dateStaged","stagedBy","stagedBatchPosition","dateLive","liveBy","dateBinned","binnedBy"],"properties":{"state":{"type":"string","enum":["BINNED"]},"dateStaged":{"type":"string","format":"date-time","description":"The datetime the asset was staged in ISO datetime format","example":"2021-02-15T09:24:01.417Z"},"stagedBy":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Users"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" who staged the asset"},"children":[]}]}]}],"example":"google-oauth2|110457667287511486432"},"stagedBatchPosition":{"type":"number","description":"The position of the asset within the batch of assets that it was staged with","example":0},"datePendingApproval":{"type":"string","nullable":true,"format":"date-time","description":"The datetime the asset was moved to pending approval in ISO datetime format","example":"2021-02-15T09:24:01.417Z"},"pendingApprovalBy":{"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 ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Users"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" who moved the asset to pending approval"},"children":[]}]}]}],"example":"google-oauth2|110457667287511486432"},"dateLive":{"type":"string","format":"date-time","description":"The datetime the asset was moved to live in ISO datetime format","example":"2021-02-15T09:24:01.417Z"},"liveBy":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Users"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" who moved the asset to live"},"children":[]}]}]}],"example":"google-oauth2|110457667287511486432"},"dateBinned":{"type":"string","format":"date-time","description":"The datetime the asset was moved to bin in ISO datetime format","example":"2021-02-15T09:24:01.417Z"},"binnedBy":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Users"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" who moved the asset to bin"},"children":[]}]}]}],"example":"google-oauth2|110457667287511486432"}}}},"components/schemas/LifecycleStatus":{"id":"components/schemas/LifecycleStatus","kind":"json-schema","title":"LifecycleStatus","data":{"oneOf":[{"$ref":"#/components/schemas/LifecycleStatusStaged"},{"$ref":"#/components/schemas/LifecycleStatusPendingApproval"},{"$ref":"#/components/schemas/LifecycleStatusLive"},{"$ref":"#/components/schemas/LifecycleStatusBinned"}],"discriminator":{"propertyName":"state","mapping":{"STAGED":"#/components/schemas/LifecycleStatusStaged","PENDING_APPROVAL":"#/components/schemas/LifecycleStatusPendingApproval","LIVE":"#/components/schemas/LifecycleStatusLive","BINNED":"#/components/schemas/LifecycleStatusBinned"}}}},"components/schemas/Metadata":{"id":"components/schemas/Metadata","kind":"json-schema","title":"Metadata","data":{"type":"object","required":["version","values"],"properties":{"version":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The current version number of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset.metadata"},"children":[]}]}]}]}],"example":11},"values":{"type":"object","additionalProperties":{"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":"Map of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field.id"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" keys to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"string[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the referenced "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field.multiValue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" then the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"string[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will contain "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the referenced "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field.multiValue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" then the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"string[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will contain "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0-1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The absence of an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field.id"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the map is equivalent to a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"string[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values. i.e. the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has no specified value for that "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field"},"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":"If the referenced "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field.hasFixedOptions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" then each item in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"string[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption.id"},"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":"The human-readable value can then be found in the referenced "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption.value"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the referenced "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field.hasFixedOptions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" then each item in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"string[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will itself be a human-readable value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Clients of the API are expected to retrieve the referenced "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" objects independently via the appropriate endpoints."},"children":[]}]}]}]},"example":{"a52b5315-15b8-417f-b742-d6902108bac1":["A view from a mountain"],"f992794c-85db-11eb-8dcd-0242ac130003":["Outdoors","Mountain","Snow"],"219bc1fa-85dc-11eb-8dcd-0242ac130003":["a32fe863-0a1d-4b54-990a-b094139cf81c","0e1bddba-9339-4e6e-b5ae-3adc60ad927a"]}}}}},"components/schemas/FileType":{"id":"components/schemas/FileType","kind":"json-schema","title":"FileType","data":{"type":"string","enum":["IMAGE","GIF","VIDEO","AUDIO","DOCUMENT","OTHER"],"example":"IMAGE"}},"components/schemas/Dimensions":{"id":"components/schemas/Dimensions","kind":"json-schema","title":"Dimensions","data":{"type":"object","required":["width","height"],"properties":{"width":{"type":"integer","description":"The width in pixels","example":800},"height":{"type":"integer","description":"The height in pixels","example":600}}}},"components/schemas/Orientation":{"id":"components/schemas/Orientation","kind":"json-schema","title":"Orientation","data":{"type":"string","enum":["PORTRAIT","LANDSCAPE","SQUARE","PANORAMIC_LANDSCAPE","PANORAMIC_PORTRAIT"],"example":"PORTRAIT"}},"components/schemas/OrientationTransformation":{"id":"components/schemas/OrientationTransformation","kind":"json-schema","title":"OrientationTransformation","data":{"type":"string","nullable":true,"enum":["HORIZONTAL","MIRROR_HORIZONTAL","ROTATE_180","MIRROR_VERTICAL","MIRROR_HORIZONTAL_ROTATE_270","ROTATE_90","MIRROR_HORRIZONTAL_ROTATE_90","ROTATE_270",null],"example":"HORIZONTAL"}},"components/schemas/MediaType":{"id":"components/schemas/MediaType","kind":"json-schema","title":"MediaType","data":{"type":"object","required":["type","subType"],"properties":{"type":{"type":"string","description":"The main type of the media","example":"image"},"subType":{"type":"string","description":"The sub type of the media","example":"jpeg"}}}},"components/schemas/GpsLocation":{"id":"components/schemas/GpsLocation","kind":"json-schema","title":"GpsLocation","data":{"type":"object","required":["latitude","longitude"],"properties":{"latitude":{"type":"number","format":"double","description":"The latitudinal component of the GPS location in degress","example":50.8256345},"longitude":{"type":"number","format":"double","description":"The longitudinal component of the GPS location in degress","example":-0.143761}}}},"components/schemas/AssetFile":{"id":"components/schemas/AssetFile","kind":"json-schema","title":"AssetFile","data":{"type":"object","required":["id","assetId","size","filename","dateAdded","fileType","usesTransparency","mediaType","previewUrl"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID for the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/getassetfiles"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetFile"},"children":[]}]}]}]}],"example":"e2b03444-8c5d-44ed-bd9f-7eee882bdf81"},"assetId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" this file belongs to"},"children":[]}]}]}],"example":"7af90a8b-7ccd-430f-a85d-e8614015bc47"},"size":{"type":"integer","description":"The size of the file in bytes","example":44040192},"filename":{"type":"string","description":"The filename","example":"a_file.jpg"},"checksum":{"type":"string","nullable":true,"description":"MD5 hash of the file","example":"120EA8A25E5D487BF68B5F7096440019"},"dateAdded":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The datetime the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/getassetfiles"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetFile"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was added in ISO datetime format"},"children":[]}]}]}],"example":"2021-02-15T09:26:01.417Z"},"fileType":{"$ref":"#/components/schemas/FileType"},"dimensions":{"description":"The pixel dimensions of the file if applicable","type":"object","nullable":true,"allOf":[{"$ref":"#/components/schemas/Dimensions"}]},"orientation":{"description":"The orientation of the file","type":"string","nullable":true,"allOf":[{"$ref":"#/components/schemas/Orientation"}]},"orientationTransformation":{"description":"The transformation that has been applied to the orientation of the file if applicable","allOf":[{"$ref":"#/components/schemas/OrientationTransformation"}]},"duration":{"description":"The duration of the file in seconds if applicable","example":null,"type":"integer","nullable":true},"usesTransparency":{"type":"boolean","description":"Whether the file uses transparency","example":false},"mediaType":{"$ref":"#/components/schemas/MediaType"},"gpsLocation":{"description":"The GPS location embedded within the file if there is one","type":"object","nullable":true,"allOf":[{"$ref":"#/components/schemas/GpsLocation"}]},"previewUrl":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A signed URL used get previews for an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/getassetfiles"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetFile"},"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 type of preview is specified in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/[WIDTH]x[HEIGHT].EXTENSION"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is then appended to the "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"path"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" part of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/getassetfiles"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetFile.previewUrl"},"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":"Note, the URL signature is present as a query parameter so clients must ensure the URL query part remains as is."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"e.g. Given an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset.previewURL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"http://123.cloudfront.net/account-1/asset-1/file-1?signature=safe"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in order to get a 100 by 200 PNG preview the modified URL would be:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"http://123.cloudfront.net/account-1/asset-1/file-1/100x200.png?signature=safe"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The preview is not guaranteed to be ready immediately."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the request to the preview URL returns a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"202"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" accepted response clients will need to periodically request again until a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" success response is received, and the preview is ready."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response is returned the requested preview cannot be generated for an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/getassetfiles"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetFile"},"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":"Current supported image preview extension are "},"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":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"webp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"webm"},"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":"An image preview can be generated for most file types"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Current supported video preview extensions are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mp4"},"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":"A video preview can only be generated for videos."},"children":[]}]}]}],"example":"https://d7h9v39iheghu.cloudfront.net/previews/7af90a8b-7ccd-430f-a85d-e8614015bc47/e2b03444-8c5d-44ed-bd9f-7eee882bdf81?Policy=OTU0MjAwfX19XX0_&Signature=begSbvwpYg&Key-Pair-Id=APKAJXJN6VNR3OLZJ"}}}},"components/schemas/Stats":{"id":"components/schemas/Stats","kind":"json-schema","title":"Stats","data":{"type":"object","required":["downloadCount"],"properties":{"downloadCount":{"type":"integer","description":"The number of times the asset has been downloaded","example":42}}}},"components/schemas/ContextComments":{"id":"components/schemas/ContextComments","kind":"json-schema","title":"ContextComments","data":{"type":"object","required":["count"],"properties":{"count":{"type":"integer","description":"The number of comments the asset has","example":4}}}},"components/schemas/ContextCommentsMap":{"id":"components/schemas/ContextCommentsMap","kind":"json-schema","title":"ContextCommentsMap","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Property names: property1, property2, etc. are contextIds."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For the given contextId, the property value is an object of comment properties."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If there are no comments, then this object has no properties, eg. {}"},"children":[]}]}]}],"additionalProperties":{"$ref":"#/components/schemas/ContextComments"}}},"components/schemas/OriginGuestUpload":{"id":"components/schemas/OriginGuestUpload","kind":"json-schema","title":"OriginGuestUpload","data":{"type":"object","required":["type","guestUploadId","temporarySessionId"],"properties":{"type":{"type":"string","enum":["GUEST_UPLOAD"]},"guestUploadId":{"type":"string","description":"The ID of the GuestUpload that this asset originated from","example":"55f9964c-095d-4b8b-bb5e-4118d2e76ad0"},"temporarySessionId":{"type":"string","description":"The ID of the temporary session that this asset originated from","example":"431263a2-a84a-4a35-86a1-c9a1ea435600"}}}},"components/schemas/Origin":{"id":"components/schemas/Origin","kind":"json-schema","title":"Origin","data":{"oneOf":[{"$ref":"#/components/schemas/OriginGuestUpload"}],"discriminator":{"propertyName":"type","mapping":{"GUEST_UPLOAD":"#/components/schemas/OriginGuestUpload"}}}},"components/schemas/Asset":{"id":"components/schemas/Asset","kind":"json-schema","title":"Asset","data":{"type":"object","required":["id","accountId","lifecycleStatus","dateLastModified","metadata","stats","contextComments"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID for the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]}]}]}],"example":"7af90a8b-7ccd-430f-a85d-e8614015bc47"},"accountId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" belongs to"},"children":[]}]}]}],"type":"string","example":"cfb665ca-ce35-4418-b9d5-70ee815db4bd"},"lifecycleStatus":{"$ref":"#/components/schemas/LifecycleStatus"},"dateLastModified":{"type":"string","description":"The datetime the asset was modified in ISO datetime format","example":"2021-02-17T09:24:01.417Z"},"metadata":{"$ref":"#/components/schemas/Metadata"},"currentAssetFile":{"type":"object","nullable":true,"allOf":[{"$ref":"#/components/schemas/AssetFile"}]},"stats":{"$ref":"#/components/schemas/Stats"},"contextComments":{"$ref":"#/components/schemas/ContextCommentsMap"},"origin":{"nullable":true,"$ref":"#/components/schemas/Origin"}}}},"components/schemas/AssetWithPermittedActions":{"id":"components/schemas/AssetWithPermittedActions","kind":"json-schema","title":"AssetWithPermittedActions","data":{"type":"object","required":["result","permittedActions"],"properties":{"result":{"$ref":"#/components/schemas/Asset"},"permittedActions":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permitted actions for "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources:"},"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":"ASSET"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" : "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DELETE_ASSET"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Whether the user can delete this "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource"},"children":[]}]}]}]}],"items":{"$ref":"#/components/schemas/PermittedAction"}}}}},"components/schemas/AssetPatchRequest":{"id":"components/schemas/AssetPatchRequest","kind":"json-schema","title":"AssetPatchRequest","data":{"type":"object","properties":{"currentAssetFileId":{"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 ID of the current "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/getassetfiles"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetFile"},"children":[]}]}]}]}],"example":"e2b03444-8c5d-44ed-bd9f-7eee882bdf81"}}}},"components/schemas/AssetsCreationRequest":{"id":"components/schemas/AssetsCreationRequest","kind":"json-schema","title":"AssetsCreationRequest","data":{"type":"object","required":["numberToCreate"],"properties":{"numberToCreate":{"type":"integer","description":"The number of assets to create","example":42}}}},"components/schemas/AssetsCreation":{"id":"components/schemas/AssetsCreation","kind":"json-schema","title":"AssetsCreation","data":{"type":"object","required":["assetIds"],"properties":{"assetIds":{"type":"array","description":"A list of the created asset's IDs","example":["2b746f61-d36d-4627-a547-936f6f20594b","23cfaab7-c9f3-4b28-ac21-7b5b18f2519a"],"items":{"type":"string"}}}}},"components/schemas/AssetsCreationWithPermittedActions":{"id":"components/schemas/AssetsCreationWithPermittedActions","kind":"json-schema","title":"AssetsCreationWithPermittedActions","data":{"type":"object","required":["result","permittedActions"],"properties":{"result":{"$ref":"#/components/schemas/AssetsCreation"},"permittedActions":{"type":"array","items":{"$ref":"#/components/schemas/PermittedAction"}}}}},"components/schemas/AssetUploadPartUrlRequest":{"id":"components/schemas/AssetUploadPartUrlRequest","kind":"json-schema","title":"AssetUploadPartUrlRequest","data":{"type":"object","required":["partNumber"],"properties":{"partNumber":{"type":"integer","description":"1-based indexing number of the part","example":2},"contentMd5":{"type":"string","description":"The MD5 hash of the content contained within the part","example":"86fb269d190d2c85f6e0468ceca42a20","nullable":true}}}},"components/schemas/AssetUploadPartUrlsRequest":{"id":"components/schemas/AssetUploadPartUrlsRequest","kind":"json-schema","title":"AssetUploadPartUrlsRequest","data":{"type":"object","required":["urlRequests"],"properties":{"uploadId":{"type":"string","example":"5a2481e0-819f-4b46-a7e6-143f943345f2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/postassetupload"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetUpload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to get URLs for.  If this is not provided, a new multi-part upload will be generated.  Therefore this only needs to be provided when not getting all upload URLs at once."},"children":[]}]}]}],"nullable":true},"urlRequests":{"type":"array","items":{"$ref":"#/components/schemas/AssetUploadPartUrlRequest"}}}}},"components/schemas/AssetUploadDetails":{"id":"components/schemas/AssetUploadDetails","kind":"json-schema","title":"AssetUploadDetails","data":{"type":"object","required":["path","size"],"properties":{"path":{"type":"string","example":"/Folder A/Folder D/a_file.jpg","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The path of the file including filename and any folders. This path will to set the value of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Folder-Settings"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Folder Field"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Set to \"/\" to upload to the top-level in Dash."},"children":[]}]}]}]},"size":{"type":"integer","description":"The size of the file that is to be uploaded (in bytes)","example":15318362},"partSize":{"description":"Optionally specify the part size (in bytes) for multi-part uploading of the file. This must be less than 5368709120, and more than 5242880 unless it is the final part. If omitted or null a default part size will be used.","type":"integer","nullable":true,"example":7000000,"maximum":5368709120},"partUrlsRequest":{"nullable":true,"$ref":"#/components/schemas/AssetUploadPartUrlsRequest"}}}},"components/schemas/AssetAndUploadBatchRequestItem":{"id":"components/schemas/AssetAndUploadBatchRequestItem","kind":"json-schema","title":"AssetAndUploadBatchRequestItem","data":{"allOf":[{"$ref":"#/components/schemas/BatchItem"},{"$ref":"#/components/schemas/AssetUploadDetails"}]}},"components/schemas/AssetAndUploadBatchRequest":{"id":"components/schemas/AssetAndUploadBatchRequest","kind":"json-schema","title":"AssetAndUploadBatchRequest","data":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/AssetAndUploadBatchRequestItem"}}}}},"components/schemas/JobStepProgress":{"id":"components/schemas/JobStepProgress","kind":"json-schema","title":"JobStepProgress","data":{"type":"object","required":["name","status","completedItems"],"properties":{"name":{"type":"string","description":"The name of the job step.","example":"STEP_NAME"},"status":{"type":"string","enum":["COMPLETED","PENDING","STARTING","STARTED","STOPPING","STOPPED","FAILED","ABANDONED","UNKNOWN"],"example":"STARTED"},"completedItems":{"type":"integer","description":"The number of items that have been completed in this step so far","example":0},"totalItems":{"type":"integer","nullable":true,"description":"The total number of items to be processed by this step if known","example":2}}}},"components/schemas/JobProgress":{"id":"components/schemas/JobProgress","kind":"json-schema","title":"JobProgress","data":{"type":"object","required":["steps"],"properties":{"steps":{"type":"array","items":{"$ref":"#/components/schemas/JobStepProgress"}}}}},"components/schemas/BaseJob":{"id":"components/schemas/BaseJob","kind":"json-schema","title":"BaseJob","data":{"type":"object","required":["id","accountId","creatorId","type","progress"],"properties":{"id":{"type":"string","description":"Unique identifier of the job that has been created","example":"be161977-d44e-4888-af3c-66522e223963"},"accountId":{"description":"The ID of the account the job is happening in","type":"string","example":"cfb665ca-ce35-4418-b9d5-70ee815db4bd"},"creatorId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Users"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" who created the job"},"children":[]}]}]}],"type":"string","example":"google-oauth2|110955770826801837334"},"type":{"type":"string","description":"The job type","enum":["IN_PROGRESS","COMPLETED","FAILED"]},"progress":{"$ref":"#/components/schemas/JobProgress"}}}},"components/schemas/InProgressJob":{"id":"components/schemas/InProgressJob","kind":"json-schema","title":"InProgressJob","data":{"allOf":[{"$ref":"#/components/schemas/BaseJob"},{"type":"object","required":["status","type"],"properties":{"status":{"type":"string","enum":["PENDING","STARTING","STARTED","STOPPING"]},"type":{"type":"string","description":"The job type","enum":["IN_PROGRESS"]}}}]}},"components/schemas/CompletedJob":{"id":"components/schemas/CompletedJob","kind":"json-schema","title":"CompletedJob","data":{"allOf":[{"$ref":"#/components/schemas/BaseJob"},{"type":"object","required":["dateCompleted","type"],"properties":{"dateCompleted":{"type":"string","format":"date-time","description":"The datetime the job was completed in ISO datetime format","example":"2021-02-15T09:24:01.417Z"},"type":{"type":"string","description":"The job type","enum":["COMPLETED"]}}}]}},"components/schemas/AssetUploadPart":{"id":"components/schemas/AssetUploadPart","kind":"json-schema","title":"AssetUploadPart","data":{"type":"object","properties":{"partNumber":{"type":"integer","description":"1-based indexing number of the part","example":2},"startByte":{"type":"integer","description":"The first byte of the file chunk to upload for this upload part","example":1048576},"endByte":{"type":"integer","description":"The last byte (inclusive) of the file chunk to upload for this upload part","example":2097151},"url":{"type":"string","description":"The URL to put the file chunk to for this upload part","example":"https://fill-this-in-later.com"}}}},"components/schemas/AssetUpload":{"id":"components/schemas/AssetUpload","kind":"json-schema","title":"AssetUpload","data":{"type":"object","required":["id","assetId","assetFileId","uploadParts"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier for the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/postassetupload"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetUpload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to this "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]}]}]}],"example":"5a2481e0-819f-4b46-a7e6-143f943345f2"},"assetId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/postassetupload"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetUpload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is for"},"children":[]}]}]}],"example":"7af90a8b-7ccd-430f-a85d-e8614015bc47"},"assetFileId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/getassetfiles"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetFile"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/postassetupload"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetUpload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is for"},"children":[]}]}]}],"example":"7af90a8b-7ccd-430f-a85d-e8614015bc47"},"uploadParts":{"type":"array","description":"A list of all the upload part destinations","items":{"$ref":"#/components/schemas/AssetUploadPart"}}}}},"components/schemas/AssetAndUploadWithPermittedActions":{"id":"components/schemas/AssetAndUploadWithPermittedActions","kind":"json-schema","title":"AssetAndUploadWithPermittedActions","data":{"type":"object","required":["result","permittedActions"],"properties":{"result":{"$ref":"#/components/schemas/AssetUpload"},"permittedActions":{"type":"array","items":{"$ref":"#/components/schemas/PermittedAction"}}}}},"components/schemas/AssetUploadFailure":{"id":"components/schemas/AssetUploadFailure","kind":"json-schema","title":"AssetUploadFailure","data":{"type":"string","enum":["ASSET_NOT_FOUND","ASSET_IS_BINNED"]}},"components/schemas/AssetAndUploadBatch":{"id":"components/schemas/AssetAndUploadBatch","kind":"json-schema","title":"AssetAndUploadBatch","data":{"type":"object","required":["successes","failures"],"properties":{"successes":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A map of assets and uploads keyed on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"batchItemId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" provided in the request"},"children":[]}]}]}],"additionalProperties":{"$ref":"#/components/schemas/AssetAndUploadWithPermittedActions"}},"failures":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A map of failures keyed on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"batchItemId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" provided in the request"},"children":[]}]}]}],"additionalProperties":{"$ref":"#/components/schemas/AssetUploadFailure"}}}}},"components/schemas/AssetAndUploadBatchCompletedJob":{"id":"components/schemas/AssetAndUploadBatchCompletedJob","kind":"json-schema","title":"AssetAndUploadBatchCompletedJob","data":{"allOf":[{"$ref":"#/components/schemas/CompletedJob"},{"type":"object","required":["result"],"properties":{"result":{"$ref":"#/components/schemas/AssetAndUploadBatch"}}}]}},"components/schemas/FailedJob":{"id":"components/schemas/FailedJob","kind":"json-schema","title":"FailedJob","data":{"allOf":[{"$ref":"#/components/schemas/BaseJob"},{"type":"object","required":["status","reason"],"properties":{"type":{"type":"string","enum":["FAILED"]},"status":{"type":"string","enum":["STOPPED","FAILED","ABANDONED","UNKNOWN"]},"reason":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}]}},"components/schemas/AssetAndUploadBatchJob":{"id":"components/schemas/AssetAndUploadBatchJob","kind":"json-schema","title":"AssetAndUploadBatchJob","data":{"oneOf":[{"$ref":"#/components/schemas/InProgressJob"},{"$ref":"#/components/schemas/AssetAndUploadBatchCompletedJob"},{"$ref":"#/components/schemas/FailedJob"}],"discriminator":{"propertyName":"type","mapping":{"IN_PROGRESS":"#/components/schemas/InProgressJob","COMPLETED":"#/components/schemas/AssetAndUploadBatchCompletedJob","FAILED":"#/components/schemas/FailedJob"}}}},"components/schemas/AssetUploadRequest":{"id":"components/schemas/AssetUploadRequest","kind":"json-schema","title":"AssetUploadRequest","data":{"allOf":[{"type":"object","required":["assetId"],"properties":{"assetId":{"type":"string","example":"7af90a8b-7ccd-430f-a85d-e8614015bc47","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to create an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/postassetupload"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetUpload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for"},"children":[]}]}]}]},"assetFileId":{"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 ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/getassetfiles"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetFile"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to create am asset upload for. If null, a new "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/getassetfiles"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetFile"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is created."},"children":[]}]}]}],"example":"7af90a8b-7ccd-430f-a85d-e8614015bc47"}}},{"$ref":"#/components/schemas/AssetUploadDetails"}]}},"components/schemas/AssetUploadWithPermittedActions":{"id":"components/schemas/AssetUploadWithPermittedActions","kind":"json-schema","title":"AssetUploadWithPermittedActions","data":{"type":"object","required":["result","permittedActions"],"properties":{"result":{"$ref":"#/components/schemas/AssetUpload"},"permittedActions":{"type":"array","items":{"$ref":"#/components/schemas/PermittedAction"}}}}},"components/schemas/AssetUploadBatchRequestItem":{"id":"components/schemas/AssetUploadBatchRequestItem","kind":"json-schema","title":"AssetUploadBatchRequestItem","data":{"allOf":[{"$ref":"#/components/schemas/BatchItem"},{"$ref":"#/components/schemas/AssetUploadRequest"}]}},"components/schemas/AssetUploadBatchRequest":{"id":"components/schemas/AssetUploadBatchRequest","kind":"json-schema","title":"AssetUploadBatchRequest","data":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/AssetUploadBatchRequestItem"}}}}},"components/schemas/AssetUploadCompletedPart":{"id":"components/schemas/AssetUploadCompletedPart","kind":"json-schema","title":"AssetUploadCompletedPart","data":{"type":"object","properties":{"partNumber":{"type":"integer","description":"1-based indexing number of the part","example":1},"eTag":{"type":"string","description":"The etag of the complete part found in the etag response header of the successful PUT","example":"756c75095b79a3a0c4d967d5b3fc28b6"}}}},"components/schemas/AssetUploadCompletionRequest":{"id":"components/schemas/AssetUploadCompletionRequest","kind":"json-schema","title":"AssetUploadCompletionRequest","data":{"type":"object","properties":{"assetId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/postassetupload"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetUpload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is for"},"children":[]}]}]}],"example":"7af90a8b-7ccd-430f-a85d-e8614015bc47"},"uploadId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier for the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/postassetupload"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetUpload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to this "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]}]}]}],"example":"5a2481e0-819f-4b46-a7e6-143f943345f2"},"parts":{"type":"array","items":{"$ref":"#/components/schemas/AssetUploadCompletedPart"}}}}},"components/schemas/AssetUploadCompletionSuccess":{"id":"components/schemas/AssetUploadCompletionSuccess","kind":"json-schema","title":"AssetUploadCompletionSuccess","data":{"type":"object","properties":{"type":{"type":"string","enum":["SUCCESS"],"example":"SUCCESS"}}}},"components/schemas/AssetUploadCompletionFailure":{"id":"components/schemas/AssetUploadCompletionFailure","kind":"json-schema","title":"AssetUploadCompletionFailure","data":{"type":"object","properties":{"type":{"type":"string","enum":["FAILURE"]},"reason":{"type":"string","description":"The reason the upload was unable to complete","enum":["UPLOAD_NOT_FOUND","UNEXPECTED_ERROR"]}}}},"components/schemas/AssetUploadCompletion":{"id":"components/schemas/AssetUploadCompletion","kind":"json-schema","title":"AssetUploadCompletion","data":{"oneOf":[{"$ref":"#/components/schemas/AssetUploadCompletionSuccess"},{"$ref":"#/components/schemas/AssetUploadCompletionFailure"}],"discriminator":{"propertyName":"type","mapping":{"SUCCESS":"#/components/schemas/AssetUploadCompletionSuccess","FAILURE":"#/components/schemas/AssetUploadCompletionFailure"}}}},"components/schemas/AssetUploadCompletionWithPermittedActions":{"id":"components/schemas/AssetUploadCompletionWithPermittedActions","kind":"json-schema","title":"AssetUploadCompletionWithPermittedActions","data":{"type":"object","required":["result","permittedActions"],"properties":{"result":{"$ref":"#/components/schemas/AssetUploadCompletion"},"permittedActions":{"type":"array","items":{"$ref":"#/components/schemas/PermittedAction"}}}}},"components/schemas/AssetFileWithPermittedActions":{"id":"components/schemas/AssetFileWithPermittedActions","kind":"json-schema","title":"AssetFileWithPermittedActions","data":{"type":"object","required":["result","permittedActions"],"properties":{"result":{"$ref":"#/components/schemas/AssetFile"},"permittedActions":{"type":"array","items":{"$ref":"#/components/schemas/PermittedAction"}}}}},"components/schemas/CropPresetParameters":{"id":"components/schemas/CropPresetParameters","kind":"json-schema","title":"CropPresetParameters","data":{"type":"object","required":["type","x","y","width","height"],"properties":{"type":{"type":"string","enum":["CROP"]},"x":{"type":"integer","description":"The x coordinate of the top left corner of the crop","example":200},"y":{"type":"integer","description":"The y coordinate of the top left corner of the crop","example":100},"width":{"type":"integer","description":"The width of the crop's bounding box","example":400},"height":{"type":"integer","description":"The height of the crop's bounding box","example":300}}}},"components/schemas/ConvertPresetParameters":{"id":"components/schemas/ConvertPresetParameters","kind":"json-schema","title":"ConvertPresetParameters","data":{"type":"object","required":["type","mediaType"],"properties":{"type":{"type":"string","enum":["CONVERT"]},"mediaType":{"description":"The media type to convert to","$ref":"#/components/schemas/MediaType"}}}},"components/schemas/PresetParameters":{"id":"components/schemas/PresetParameters","kind":"json-schema","title":"PresetParameters","data":{"oneOf":[{"$ref":"#/components/schemas/CropPresetParameters"},{"$ref":"#/components/schemas/ConvertPresetParameters"}],"discriminator":{"propertyName":"type","mapping":{"CROP":"#/components/schemas/CropPresetParameters","CONVERT":"#/components/schemas/ConvertPresetParameters"}}}},"components/schemas/AssetDownloadDetails":{"id":"components/schemas/AssetDownloadDetails","kind":"json-schema","title":"AssetDownloadDetails","data":{"type":"object","required":["assetId"],"properties":{"assetId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to create a download for"},"children":[]}]}]}],"example":"7af90a8b-7ccd-430f-a85d-e8614015bc47"},"assetFileId":{"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 ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/getassetfiles"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetFile"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to create a download for. If null the current "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/getassetfiles"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetFile"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used."},"children":[]}]}]}],"example":"7af90a8b-7ccd-430f-a85d-e8614015bc47"},"outputFilename":{"type":"string","nullable":true,"description":"The filename to set in the Content-Disposition response header of the download URL. If null the original file name is used.\n"},"presetParameters":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PresetParameters for this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"assetId"},"children":[]}]}]}],"default":[],"items":{"$ref":"#/components/schemas/PresetParameters"}}}}},"components/schemas/AssetDownloadBatchRequestItem":{"id":"components/schemas/AssetDownloadBatchRequestItem","kind":"json-schema","title":"AssetDownloadBatchRequestItem","data":{"allOf":[{"$ref":"#/components/schemas/BatchItem"},{"$ref":"#/components/schemas/AssetDownloadDetails"}]}},"components/schemas/MatchesMediaTypesTransformationCriterion":{"id":"components/schemas/MatchesMediaTypesTransformationCriterion","kind":"json-schema","title":"MatchesMediaTypesTransformationCriterion","data":{"type":"object","required":["type","mediaTypes"],"properties":{"type":{"type":"string","enum":["MATCHES_MEDIA_TYPES"]},"mediaTypes":{"type":"array","description":"Match files with these media types","items":{"$ref":"#/components/schemas/MediaType"}}}}},"components/schemas/IsTransparentTransformationCriterion":{"id":"components/schemas/IsTransparentTransformationCriterion","kind":"json-schema","title":"IsTransparentTransformationCriterion","data":{"type":"object","required":["type","isTransparent"],"properties":{"type":{"type":"string","enum":["IS_TRANSPARENT"]},"isTransparent":{"type":"boolean","description":"Match files with a transparency value of this","example":true}}}},"components/schemas/TransformationCriterion":{"id":"components/schemas/TransformationCriterion","kind":"json-schema","title":"TransformationCriterion","data":{"oneOf":[{"$ref":"#/components/schemas/MatchesMediaTypesTransformationCriterion"},{"$ref":"#/components/schemas/IsTransparentTransformationCriterion"}],"discriminator":{"propertyName":"type","mapping":{"MATCHES_MEDIA_TYPES":"#/components/schemas/MatchesMediaTypesTransformationCriterion","IS_TRANSPARENT":"#/components/schemas/IsTransparentTransformationCriterion"}}}},"components/schemas/CropTransformation":{"id":"components/schemas/CropTransformation","kind":"json-schema","title":"CropTransformation","data":{"type":"object","required":["type","x","y","width","height"],"properties":{"type":{"type":"string","enum":["CROP"]},"x":{"type":"integer","description":"The x coordinate of the top left corner of the crop","example":200},"y":{"type":"integer","description":"The y coordinate of the top left corner of the crop","example":100},"width":{"type":"integer","description":"The width of the crop's bounding box","example":400},"height":{"type":"integer","description":"The height of the crop's bounding box","example":300}}}},"components/schemas/ResizeTransformation":{"id":"components/schemas/ResizeTransformation","kind":"json-schema","title":"ResizeTransformation","data":{"type":"object","required":["type","width","height"],"properties":{"type":{"type":"string","enum":["RESIZE"]},"width":{"type":"integer","description":"The maximum width the resized file should have","example":400},"height":{"type":"integer","description":"The maxium height the resized file should have","example":300}}}},"components/schemas/ConvertTransformation":{"id":"components/schemas/ConvertTransformation","kind":"json-schema","title":"ConvertTransformation","data":{"type":"object","required":["type","mediaType"],"properties":{"type":{"type":"string","enum":["CONVERT"]},"mediaType":{"description":"The media type to convert to","$ref":"#/components/schemas/MediaType"}}}},"components/schemas/ConvertBitrateTransformation":{"id":"components/schemas/ConvertBitrateTransformation","kind":"json-schema","title":"ConvertBitrateTransformation","data":{"type":"object","required":["type","videoBitRate","audioBitRate","audioSampleRate"],"properties":{"type":{"type":"string","enum":["CONVERT_BITRATE"]},"videoBitRate":{"type":"integer","description":"The bit rate in bits per second to convert the video to","example":2000},"audioBitRate":{"type":"integer","description":"The bit rate in bits per second to convert the audio to","example":96},"audioSampleRate":{"type":"integer","description":"The sample rate in hurtz to convert the audio to","example":48}}}},"components/schemas/ClipTransformation":{"id":"components/schemas/ClipTransformation","kind":"json-schema","title":"ClipTransformation","data":{"type":"object","required":["type","startTimecode","endTimecode"],"properties":{"type":{"type":"string","enum":["CLIP"]},"startTimecode":{"type":"string","description":"The timecode to start the clip from, in the format HH:MM:SS:FF","example":"00:33:22:56"},"endTimecode":{"type":"string","description":"The timecode to end the clip at, in the format HH:MM:SS:FF","example":"00:56:33:22"}}}},"components/schemas/Transformation":{"id":"components/schemas/Transformation","kind":"json-schema","title":"Transformation","data":{"oneOf":[{"$ref":"#/components/schemas/CropTransformation"},{"$ref":"#/components/schemas/ResizeTransformation"},{"$ref":"#/components/schemas/ConvertTransformation"},{"$ref":"#/components/schemas/ConvertBitrateTransformation"},{"$ref":"#/components/schemas/ClipTransformation"}],"discriminator":{"propertyName":"type","mapping":{"CROP":"#/components/schemas/CropTransformation","RESIZE":"#/components/schemas/ResizeTransformation","CONVERT":"#/components/schemas/ConvertTransformation","CONVERT_BITRATE":"#/components/schemas/ConvertBitrateTransformation","CLIP":"#/components/schemas/ClipTransformation"}}}},"components/schemas/CandidateTransformation":{"id":"components/schemas/CandidateTransformation","kind":"json-schema","title":"CandidateTransformation","data":{"type":"object","required":["criteria","transformation"],"properties":{"criteria":{"type":"array","items":{"$ref":"#/components/schemas/TransformationCriterion"}},"transformation":{"type":"array","items":{"$ref":"#/components/schemas/Transformation"},"default":[]}}}},"components/schemas/CustomTransformationDescription":{"id":"components/schemas/CustomTransformationDescription","kind":"json-schema","title":"CustomTransformationDescription","data":{"type":"object","required":["type","candidateTransformations"],"properties":{"type":{"type":"string","enum":["CUSTOM"]},"candidateTransformations":{"type":"array","items":{"$ref":"#/components/schemas/CandidateTransformation"}}}}},"components/schemas/PresetTransformationDescription":{"id":"components/schemas/PresetTransformationDescription","kind":"json-schema","title":"PresetTransformationDescription","data":{"type":"object","required":["type","presetTransformationId"],"properties":{"type":{"type":"string","enum":["PRESET"]},"presetTransformationId":{"type":"string","description":"The ID of the preset transformation to use to transform the assets","example":"a060635d-5807-4115-a2ed-f0588d47e7ba"}}}},"components/schemas/TransformationDescription":{"id":"components/schemas/TransformationDescription","kind":"json-schema","title":"TransformationDescription","data":{"oneOf":[{"$ref":"#/components/schemas/CustomTransformationDescription"},{"$ref":"#/components/schemas/PresetTransformationDescription"}],"discriminator":{"propertyName":"type","mapping":{"CUSTOM":"#/components/schemas/CustomTransformationDescription","PRESET":"#/components/schemas/PresetTransformationDescription"}}}},"components/schemas/AssetDownloadBatchRequest":{"id":"components/schemas/AssetDownloadBatchRequest","kind":"json-schema","title":"AssetDownloadBatchRequest","data":{"type":"object","required":["items","transformationDescription","zip"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/AssetDownloadBatchRequestItem"}},"transformationDescription":{"$ref":"#/components/schemas/TransformationDescription"},"zip":{"type":"boolean","description":"Whether to combine all the output files into a zip","example":true}}}},"components/schemas/AssetDownload":{"id":"components/schemas/AssetDownload","kind":"json-schema","title":"AssetDownload","data":{"type":"object","required":["url"],"properties":{"url":{"type":"string"}}}},"components/schemas/AssetDownloadWithPermittedActions":{"id":"components/schemas/AssetDownloadWithPermittedActions","kind":"json-schema","title":"AssetDownloadWithPermittedActions","data":{"type":"object","required":["result","permittedActions"],"properties":{"result":{"$ref":"#/components/schemas/AssetDownload"},"permittedActions":{"type":"array","items":{"$ref":"#/components/schemas/PermittedAction"}}}}},"components/schemas/AssetDownloadFailure":{"id":"components/schemas/AssetDownloadFailure","kind":"json-schema","title":"AssetDownloadFailure","data":{"type":"string","enum":["ASSET_NOT_FOUND","ASSET_FILE_NOT_FOUND","ASSET_FILE_NOT_READY","INVALID_TRANSFORMATION","TRANSFORMATION_FAILED","COULD_NOT_ADD_TO_ZIP"]}},"components/schemas/AssetDownloadBatch":{"id":"components/schemas/AssetDownloadBatch","kind":"json-schema","title":"AssetDownloadBatch","data":{"type":"object","required":["successes","failures"],"properties":{"successes":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A map of successful results keyed on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"batchItemId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" provided in the request"},"children":[]}]}]}],"additionalProperties":{"$ref":"#/components/schemas/AssetDownloadWithPermittedActions"}},"failures":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A map of failures keyed on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"batchItemId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" provided in the request"},"children":[]}]}]}],"additionalProperties":{"$ref":"#/components/schemas/AssetDownloadFailure"}},"zipUrl":{"type":"string","nullable":true,"description":"URL to download the zip file coontaining all the succesful Asset Downloads (it was requested)","example":"https://zip-url-example.here"}}}},"components/schemas/AssetDownloadBatchCompletedJob":{"id":"components/schemas/AssetDownloadBatchCompletedJob","kind":"json-schema","title":"AssetDownloadBatchCompletedJob","data":{"allOf":[{"$ref":"#/components/schemas/CompletedJob"},{"type":"object","required":["result"],"properties":{"result":{"$ref":"#/components/schemas/AssetDownloadBatch"}}}]}},"components/schemas/AssetDownloadBatchJob":{"id":"components/schemas/AssetDownloadBatchJob","kind":"json-schema","title":"AssetDownloadBatchJob","data":{"oneOf":[{"$ref":"#/components/schemas/InProgressJob"},{"$ref":"#/components/schemas/AssetDownloadBatchCompletedJob"},{"$ref":"#/components/schemas/FailedJob"}],"discriminator":{"propertyName":"type","mapping":{"IN_PROGRESS":"#/components/schemas/InProgressJob","COMPLETED":"#/components/schemas/AssetDownloadBatchCompletedJob","FAILED":"#/components/schemas/FailedJob"}}}},"components/schemas/AssetSearchFieldFixed":{"id":"components/schemas/AssetSearchFieldFixed","kind":"json-schema","title":"AssetSearchFieldFixed","data":{"type":"object","required":["type","fieldName"],"properties":{"type":{"type":"string","enum":["FIXED"]},"fieldName":{"type":"string","enum":["STAGED_BY","PENDING_APPROVAL_BY","LIVE_BY","COLLECTIONS","DATE_LIVE","DATE_PENDING_APPROVAL","DATE_STAGED","DATE_LAST_MODIFIED","DATE_LAST_ASSET_FILE_ADDED","DOWNLOAD_COUNT","FILE_SIZE","FILE_TYPE","FILE_CHECKSUM","FILENAME","ID","KEYWORDS","KEYWORDS_WITHOUT_FILE_SEMANTIC_MEANING","KEYWORDS_WITH_FILE_SEMANTIC_MEANING","ORIENTATION","LIFECYCLE_STATE","DATE_BINNED","BINNED_BY","WIDTH","HEIGHT","ORIGIN_TEMPORARY_SESSION_ID","ORIGIN_GUEST_UPLOAD_ID","PRODUCT_ID","PRODUCT_NAME","PRODUCT_VARIANT_ID","PRODUCT_VARIANT_SKU"],"example":"STAGED_BY","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the fixed "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property value used to search on."},"children":[]}]}]}]}}}},"components/schemas/AssetSearchFieldField":{"id":"components/schemas/AssetSearchFieldField","kind":"json-schema","title":"AssetSearchFieldField","data":{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["FIELD"]},"fieldId":{"type":"string","example":"a52b5315-15b8-417f-b742-d6902108bac1","description":[{"$$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":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field.id"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to which the criterion applies.  i.e. the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset.metadata.values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" key of the map value used to search on."},"children":[]}]}]}]}}}},"components/schemas/AssetSearchField":{"id":"components/schemas/AssetSearchField","kind":"json-schema","title":"AssetSearchField","data":{"oneOf":[{"$ref":"#/components/schemas/AssetSearchFieldFixed"},{"$ref":"#/components/schemas/AssetSearchFieldField"}],"discriminator":{"propertyName":"type","mapping":{"FIXED":"#/components/schemas/AssetSearchFieldFixed","FIELD":"#/components/schemas/AssetSearchFieldField"}}}},"components/schemas/AssetFieldEqualsSearchCriterion":{"id":"components/schemas/AssetFieldEqualsSearchCriterion","kind":"json-schema","title":"AssetFieldEqualsSearchCriterion","data":{"allOf":[{"$ref":"#/components/schemas/FieldEqualsSearchCriterion"},{"type":"object","required":["type","field"],"properties":{"type":{"type":"string","enum":["FIELD_EQUALS"]},"field":{"$ref":"#/components/schemas/AssetSearchField"},"includeDescendants":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the field is hierarchical, then a value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will include assets with descendant field values, e.g. in sub-folders, while "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will include only assets with the field value specified."},"children":[]}]}]}],"default":true},"boost":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A floating-point value that specifies the weight of this field toward the relevance score. Values above 1.0 increase the field’s relevance. Values between 0.0 and 1.0 decrease the field’s relevance. Default is 1.0."},"children":[]}]}]}],"nullable":true,"default":null}}}]}},"components/schemas/AssetFieldHasAnyEqualSearchCriterion":{"id":"components/schemas/AssetFieldHasAnyEqualSearchCriterion","kind":"json-schema","title":"AssetFieldHasAnyEqualSearchCriterion","data":{"allOf":[{"$ref":"#/components/schemas/FieldInSearchCriterion"},{"type":"object","required":["type","field"],"properties":{"type":{"type":"string","enum":["FIELD_HAS_ANY_EQUAL"]},"field":{"$ref":"#/components/schemas/AssetSearchField"},"includeDescendants":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the field is hierarchical, then a value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will include assets with descendant field values, e.g. in sub-folders, while "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will include only assets with the field value specified."},"children":[]}]}]}],"default":true},"boost":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A floating-point value that specifies the weight of this field toward the relevance score. Values above 1.0 increase the field’s relevance. Values between 0.0 and 1.0 decrease the field’s relevance. Default is 1.0."},"children":[]}]}]}],"nullable":true,"default":null}}}]}},"components/schemas/AssetFieldHasAllEqualSearchCriterion":{"id":"components/schemas/AssetFieldHasAllEqualSearchCriterion","kind":"json-schema","title":"AssetFieldHasAllEqualSearchCriterion","data":{"allOf":[{"$ref":"#/components/schemas/FieldInSearchCriterion"},{"type":"object","required":["type","field"],"properties":{"type":{"type":"string","enum":["FIELD_HAS_ALL_EQUAL"]},"field":{"$ref":"#/components/schemas/AssetSearchField"},"includeDescendants":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the field is hierarchical, then a value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will include assets with descendant field values, e.g. in sub-folders, while "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will include only assets with the field value specified."},"children":[]}]}]}],"default":true},"boost":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A floating-point value that specifies the weight of this field toward the relevance score. Values above 1.0 increase the field’s relevance. Values between 0.0 and 1.0 decrease the field’s relevance. Default is 1.0."},"children":[]}]}]}],"nullable":true,"default":null}}}]}},"components/schemas/FieldMatchesSearchCriterion":{"id":"components/schemas/FieldMatchesSearchCriterion","kind":"json-schema","title":"FieldMatchesSearchCriterion","data":{"allOf":[{"$ref":"#/components/schemas/SearchCriterion"},{"type":"object","required":["value"],"properties":{"value":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value to match against. Supports wildcard syntax and ranges in the form "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[this TO that]"},"children":[]}]}]}],"example":"*older"}}}]}},"components/schemas/AssetFieldMatchesSearchCriterion":{"id":"components/schemas/AssetFieldMatchesSearchCriterion","kind":"json-schema","title":"AssetFieldMatchesSearchCriterion","data":{"allOf":[{"$ref":"#/components/schemas/FieldMatchesSearchCriterion"},{"type":"object","required":["type","field"],"properties":{"type":{"type":"string","enum":["FIELD_MATCHES"]},"field":{"$ref":"#/components/schemas/AssetSearchField"},"includeDescendants":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the field is hierarchical, then a value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will include assets with descendant field values, e.g. in sub-folders, while "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will include only assets with the field value specified."},"children":[]}]}]}],"default":true},"boost":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A floating-point value that specifies the weight of this field toward the relevance score. Values above 1.0 increase the field’s relevance. Values between 0.0 and 1.0 decrease the field’s relevance. Default is 1.0."},"children":[]}]}]}],"nullable":true,"default":null}}}]}},"components/schemas/AssetFieldIsEmptySearchCriterion":{"id":"components/schemas/AssetFieldIsEmptySearchCriterion","kind":"json-schema","title":"AssetFieldIsEmptySearchCriterion","data":{"allOf":[{"$ref":"#/components/schemas/FieldIsEmptySearchCriterion"},{"type":"object","required":["type","field"],"properties":{"type":{"type":"string","enum":["FIELD_IS_EMPTY"]},"field":{"$ref":"#/components/schemas/AssetSearchField"}}}]}},"components/schemas/AssetIsSimilarToAssetCriterion":{"id":"components/schemas/AssetIsSimilarToAssetCriterion","kind":"json-schema","title":"AssetIsSimilarToAssetCriterion","data":{"allOf":[{"$ref":"#/components/schemas/SearchCriterion"},{"type":"object","required":["type","assetId"],"properties":{"type":{"type":"string","enum":["IS_SIMILAR_TO_ASSET"]},"assetId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID for the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to look for conceptually similar matches of"},"children":[]}]}]}],"example":"7af90a8b-7ccd-430f-a85d-e8614015bc47"},"threshold":{"type":"number","description":"Cut off point for how similar the matches have to be, with 1 being an exact match and 0 being completely different","example":0.8,"nullable":true}}}]}},"components/schemas/MatchNoneSearchCriterion":{"id":"components/schemas/MatchNoneSearchCriterion","kind":"json-schema","title":"MatchNoneSearchCriterion","data":{"allOf":[{"$ref":"#/components/schemas/SearchCriterion"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["MATCH_NONE"]}}}]}},"components/schemas/AssetSearchCriterion":{"id":"components/schemas/AssetSearchCriterion","kind":"json-schema","title":"AssetSearchCriterion","data":{"oneOf":[{"$ref":"#/components/schemas/AssetFieldEqualsSearchCriterion"},{"$ref":"#/components/schemas/AssetFieldHasAnyEqualSearchCriterion"},{"$ref":"#/components/schemas/AssetFieldHasAllEqualSearchCriterion"},{"$ref":"#/components/schemas/AssetFieldMatchesSearchCriterion"},{"$ref":"#/components/schemas/AssetFieldIsEmptySearchCriterion"},{"$ref":"#/components/schemas/AssetAndSearchCriterion"},{"$ref":"#/components/schemas/AssetOrSearchCriterion"},{"$ref":"#/components/schemas/AssetNotSearchCriterion"},{"$ref":"#/components/schemas/AssetIsSimilarToAssetCriterion"},{"$ref":"#/components/schemas/MatchAllSearchCriterion"},{"$ref":"#/components/schemas/MatchNoneSearchCriterion"}],"discriminator":{"propertyName":"type","mapping":{"FIELD_EQUALS":"#/components/schemas/AssetFieldEqualsSearchCriterion","FIELD_HAS_ANY_EQUAL":"#/components/schemas/AssetFieldHasAnyEqualSearchCriterion","FIELD_HAS_ALL_EQUAL":"#/components/schemas/AssetFieldHasAllEqualSearchCriterion","FIELD_MATCHES":"#/components/schemas/AssetFieldMatchesSearchCriterion","FIELD_IS_EMPTY":"#/components/schemas/AssetFieldIsEmptySearchCriterion","IS_SIMILAR_TO_ASSET":"#/components/schemas/AssetIsSimilarToAssetCriterion","MATCH_ALL":"#/components/schemas/MatchAllSearchCriterion","MATCH_NONE":"#/components/schemas/MatchNoneSearchCriterion","AND":"#/components/schemas/AssetAndSearchCriterion","OR":"#/components/schemas/AssetOrSearchCriterion","NOT":"#/components/schemas/AssetNotSearchCriterion"}}}},"components/schemas/AssetAndSearchCriterion":{"id":"components/schemas/AssetAndSearchCriterion","kind":"json-schema","title":"AssetAndSearchCriterion","data":{"allOf":[{"$ref":"#/components/schemas/SearchCriterion"},{"type":"object","required":["type","criteria"],"properties":{"type":{"type":"string","enum":["AND"]},"criteria":{"type":"array","description":"The list of criteria to AND together","items":{"$ref":"#/components/schemas/AssetSearchCriterion"}}}}]}},"components/schemas/AssetOrSearchCriterion":{"id":"components/schemas/AssetOrSearchCriterion","kind":"json-schema","title":"AssetOrSearchCriterion","data":{"allOf":[{"$ref":"#/components/schemas/SearchCriterion"},{"type":"object","required":["type","criteria"],"properties":{"type":{"type":"string","enum":["OR"]},"criteria":{"type":"array","description":"The list of criteria to OR together","items":{"$ref":"#/components/schemas/AssetSearchCriterion"}}}}]}},"components/schemas/AssetNotSearchCriterion":{"id":"components/schemas/AssetNotSearchCriterion","kind":"json-schema","title":"AssetNotSearchCriterion","data":{"allOf":[{"$ref":"#/components/schemas/SearchCriterion"},{"type":"object","required":["type","criterion"],"properties":{"type":{"type":"string","enum":["NOT"]},"criterion":{"description":"The criterion to negate","$ref":"#/components/schemas/AssetSearchCriterion"}}}]}},"components/schemas/AssetSortFieldFixed":{"id":"components/schemas/AssetSortFieldFixed","kind":"json-schema","title":"AssetSortFieldFixed","data":{"type":"object","required":["type","fieldName"],"properties":{"type":{"type":"string","enum":["FIXED"]},"fieldName":{"type":"string","enum":["STAGED_BY","PENDING_APPROVAL_BY","LIVE_BY","DATE_LIVE","DATE_PENDING_APPROVAL","DATE_STAGED","DATE_LAST_MODIFIED","DATE_LAST_ASSET_FILE_ADDED","DOWNLOAD_COUNT","FILE_SIZE","FILE_TYPE","FILENAME","ID","ORIENTATION","RELEVANCE","LIFECYCLE_STATE","DATE_BINNED","BINNED_BY","STAGED_BATCH_POSITION","STAGED_ORDER","ADDED_ORDER"],"example":"STAGED_BY","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the fixed "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property value used to sort on."},"children":[]}]}]}]}}}},"components/schemas/AssetSortFieldField":{"id":"components/schemas/AssetSortFieldField","kind":"json-schema","title":"AssetSortFieldField","data":{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["FIELD"]},"fieldId":{"type":"string","example":"a52b5315-15b8-417f-b742-d6902108bac1","description":[{"$$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":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field.id"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to which the sort applies.  i.e. the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset.metadata.values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" key of the map value used to sort on."},"children":[]}]}]}]}}}},"components/schemas/AssetSortField":{"id":"components/schemas/AssetSortField","kind":"json-schema","title":"AssetSortField","data":{"oneOf":[{"$ref":"#/components/schemas/AssetSortFieldFixed"},{"$ref":"#/components/schemas/AssetSortFieldField"}],"discriminator":{"propertyName":"type","mapping":{"FIXED":"#/components/schemas/AssetSortFieldFixed","FIELD":"#/components/schemas/AssetSortFieldField"}}}},"components/schemas/AssetSort":{"id":"components/schemas/AssetSort","kind":"json-schema","title":"AssetSort","data":{"type":"object","required":["field","order"],"properties":{"field":{"$ref":"#/components/schemas/AssetSortField"},"order":{"$ref":"#/components/schemas/SortOrder"}}}},"components/schemas/BaseAssetSearchRequest":{"id":"components/schemas/BaseAssetSearchRequest","kind":"json-schema","title":"BaseAssetSearchRequest","data":{"type":"object","required":["criterion","sorts"],"properties":{"criterion":{"description":"The search criterion","$ref":"#/components/schemas/AssetSearchCriterion"},"sorts":{"description":"Sorts to be applied to the search in order of precedence","type":"array","items":{"$ref":"#/components/schemas/AssetSort"}},"action":{"type":"string","default":"SEARCH_FOR_VIEW","example":"SEARCH_FOR_VIEW","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the context in which the search is being run. For example if you only want to return "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources that the search "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Users"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has permission to delete then set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"action"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SEARCH_FOR_DELETE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["SEARCH_FOR_CHANGE_LIFECYCLE_STATE_TO_PENDING_APPROVAL","SEARCH_FOR_CHANGE_LIFECYCLE_STATE_TO_LIVE","SEARCH_FOR_CHANGE_LIFECYCLE_STATE_TO_BINNED","SEARCH_FOR_DELETE","SEARCH_FOR_EDIT","SEARCH_FOR_PROMOTE_TO_LIVE","SEARCH_FOR_SEND_FOR_APPROVAL","SEARCH_FOR_VIEW"]}}}},"components/schemas/AssetAggregationRequestInclusionOptions":{"id":"components/schemas/AssetAggregationRequestInclusionOptions","kind":"json-schema","title":"AssetAggregationRequestInclusionOptions","data":{"type":"object","description":"Field values to include and/or exclude in the aggregation. Exclusions take precedence over inclusions.","properties":{"includeTerms":{"type":"array","description":"If set, only the listed field values will be included in the aggregation","items":{"type":"string"}},"excludeTerms":{"type":"array","description":"If set, all listed field values will be excluded from the aggregation","items":{"type":"string"}}}}},"components/schemas/AssetTermsAggregationRequest":{"id":"components/schemas/AssetTermsAggregationRequest","kind":"json-schema","title":"AssetTermsAggregationRequest","data":{"type":"object","required":["type","field"],"properties":{"type":{"type":"string"},"field":{"$ref":"#/components/schemas/AssetSearchField"},"valueWhenMissing":{"type":"string","description":"The value to assign to assets that do not have a value for the field that you are aggregating upon","example":"Unknown"},"inclusionOptions":{"$ref":"#/components/schemas/AssetAggregationRequestInclusionOptions"}}}},"components/schemas/AssetAggregationRequest":{"id":"components/schemas/AssetAggregationRequest","kind":"json-schema","title":"AssetAggregationRequest","data":{"oneOf":[{"$ref":"#/components/schemas/AssetTermsAggregationRequest"}],"discriminator":{"propertyName":"type","mapping":{"TERMS":"#/components/schemas/AssetTermsAggregationRequest"}}}},"components/schemas/AssetAggregationRequestsMap":{"id":"components/schemas/AssetAggregationRequestsMap","kind":"json-schema","title":"AssetAggregationRequestsMap","data":{"type":"object","properties":{"aggregations":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AssetAggregationRequest"},"description":"A map of requested aggregations. The results will be returned in a map with the same provided keys."}}}},"components/schemas/AssetPaginatedSearchRequest":{"id":"components/schemas/AssetPaginatedSearchRequest","kind":"json-schema","title":"AssetPaginatedSearchRequest","data":{"allOf":[{"$ref":"#/components/schemas/BasePaginatedSearchInAccountRequest"},{"$ref":"#/components/schemas/BaseAssetSearchRequest"},{"$ref":"#/components/schemas/AssetAggregationRequestsMap"}]}},"components/schemas/BaseAssetSearch":{"id":"components/schemas/BaseAssetSearch","kind":"json-schema","title":"BaseAssetSearch","data":{"type":"object","required":["results","totalResults"],"properties":{"results":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The requested page of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources which match the search criterion"},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/AssetWithPermittedActions"}},"totalResults":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total number of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources which match the search criterion"},"children":[]}]}]}],"example":1337}}}},"components/schemas/AssetAggregationBucket":{"id":"components/schemas/AssetAggregationBucket","kind":"json-schema","title":"AssetAggregationBucket","data":{"type":"object","required":["key","count"],"properties":{"key":{"type":"string","description":"The unique name of the bucket","example":null},"count":{"type":"integer","description":"The number of assets in the bucket","example":15}}}},"components/schemas/AssetAggregationBucketResponse":{"id":"components/schemas/AssetAggregationBucketResponse","kind":"json-schema","title":"AssetAggregationBucketResponse","data":{"type":"object","required":["type","buckets"],"properties":{"type":{"type":"string"},"buckets":{"description":"The collection of unique buckets within the requested aggregation","type":"array","items":{"$ref":"#/components/schemas/AssetAggregationBucket"}}}}},"components/schemas/AssetAggregationResponse":{"id":"components/schemas/AssetAggregationResponse","kind":"json-schema","title":"AssetAggregationResponse","data":{"oneOf":[{"$ref":"#/components/schemas/AssetAggregationBucketResponse"}],"discriminator":{"propertyName":"type","mapping":{"BUCKET":"#/components/schemas/AssetAggregationBucketResponse"}}}},"components/schemas/AssetAggregationResponsesMap":{"id":"components/schemas/AssetAggregationResponsesMap","kind":"json-schema","title":"AssetAggregationResponsesMap","data":{"type":"object","properties":{"aggregations":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AssetAggregationResponse"},"description":"A map of the aggregations requested keyed on the keys provided by the user in the request."}}}},"components/schemas/AssetSearch":{"id":"components/schemas/AssetSearch","kind":"json-schema","title":"AssetSearch","data":{"allOf":[{"$ref":"#/components/schemas/BaseAssetSearch"},{"$ref":"#/components/schemas/AssetAggregationResponsesMap"},{"type":"object"}]}},"components/schemas/BaseScrollSearchInAccountRequest":{"id":"components/schemas/BaseScrollSearchInAccountRequest","kind":"json-schema","title":"BaseScrollSearchInAccountRequest","data":{"type":"object","properties":{"pageSize":{"description":"The maximum number of items to return in the result set.","type":"integer","minimum":0,"maximum":1000,"example":100,"default":100}}}},"components/schemas/AssetScrollSearchRequest":{"id":"components/schemas/AssetScrollSearchRequest","kind":"json-schema","title":"AssetScrollSearchRequest","data":{"allOf":[{"$ref":"#/components/schemas/BaseScrollSearchInAccountRequest"},{"$ref":"#/components/schemas/BaseAssetSearchRequest"}]}},"components/schemas/AssetScrollSearch":{"id":"components/schemas/AssetScrollSearch","kind":"json-schema","title":"AssetScrollSearch","data":{"allOf":[{"$ref":"#/components/schemas/BaseAssetSearch"},{"type":"object","required":["scrollId"],"properties":{"scrollId":{"type":"string","example":"58b0d88b-d0c9-47fc-9038-7195b234cc0b","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID used to continue the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/postassetscrollsearch"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetScrollSearch"},"children":[]}]}]}]}]}}}]}},"components/schemas/AssetScrollSearchScrollRequest":{"id":"components/schemas/AssetScrollSearchScrollRequest","kind":"json-schema","title":"AssetScrollSearchScrollRequest","data":{"type":"object","required":["scrollId"],"properties":{"scrollId":{"type":"string","example":"58b0d88b-d0c9-47fc-9038-7195b234cc0b","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID to continue the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/postassetscrollsearch"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetScrollSearch"},"children":[]}]}]}]}]}}}},"components/schemas/AssetsSelectorByCriterion":{"id":"components/schemas/AssetsSelectorByCriterion","kind":"json-schema","title":"AssetsSelectorByCriterion","data":{"type":"object","required":["type","criterion"],"properties":{"type":{"type":"string","enum":["BY_CRITERION"]},"criterion":{"$ref":"#/components/schemas/AssetSearchCriterion"}}}},"components/schemas/AssetsSelectorByIds":{"id":"components/schemas/AssetsSelectorByIds","kind":"json-schema","title":"AssetsSelectorByIds","data":{"type":"object","required":["type","ids"],"properties":{"type":{"type":"string","enum":["BY_IDS"]},"ids":{"type":"array","description":"The list of assets ids to select","items":{"type":"string"}}}}},"components/schemas/AssetsSelector":{"id":"components/schemas/AssetsSelector","kind":"json-schema","title":"AssetsSelector","data":{"oneOf":[{"$ref":"#/components/schemas/AssetsSelectorByCriterion"},{"$ref":"#/components/schemas/AssetsSelectorByIds"}],"discriminator":{"propertyName":"type","mapping":{"BY_CRITERION":"#/components/schemas/AssetsSelectorByCriterion","BY_IDS":"#/components/schemas/AssetsSelectorByIds"}}}},"components/schemas/MetadataFieldValueUpdateOperation":{"id":"components/schemas/MetadataFieldValueUpdateOperation","kind":"json-schema","title":"MetadataFieldValueUpdateOperation","data":{"type":"string","enum":["ADD","REMOVE","SET"],"example":"REMOVE"}},"components/schemas/MetadataFieldValueUpdateByValues":{"id":"components/schemas/MetadataFieldValueUpdateByValues","kind":"json-schema","title":"MetadataFieldValueUpdateByValues","data":{"type":"object","required":["type","operation","fieldId","values"],"properties":{"type":{"type":"string","enum":["BY_VALUES"]},"operation":{"$ref":"#/components/schemas/MetadataFieldValueUpdateOperation","description":"What metadata value update operation this is.  ADD adds the specified values to the existing set of values for the field, REMOVE removes the specified values from the existing values, and SET replaces the existing values with the specified values."},"fieldId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to apply the update to"},"children":[]}]}]}],"example":"a52b5315-15b8-417f-b742-d6902108bac1"},"values":{"type":"array","description":"The list of values to update the specified field with","items":{"type":"string"}}}}},"components/schemas/MetadataFieldValueUpdateByIds":{"id":"components/schemas/MetadataFieldValueUpdateByIds","kind":"json-schema","title":"MetadataFieldValueUpdateByIds","data":{"type":"object","required":["type","operation","fieldId","ids"],"properties":{"type":{"type":"string","enum":["BY_IDS"]},"operation":{"$ref":"#/components/schemas/MetadataFieldValueUpdateOperation","description":"What metadata value update operation this is.  ADD adds the specified values to the existing set of values for the field, REMOVE removes the specified values from the existing values, and SET replaces the existing values with the specified values."},"fieldId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to apply the update to"},"children":[]}]}]}],"example":"a52b5315-15b8-417f-b742-d6902108bac1"},"ids":{"type":"array","description":"The list of field option ids to update the specified field with","items":{"type":"string"}}}}},"components/schemas/MetadataFieldValueUpdate":{"id":"components/schemas/MetadataFieldValueUpdate","kind":"json-schema","title":"MetadataFieldValueUpdate","data":{"oneOf":[{"$ref":"#/components/schemas/MetadataFieldValueUpdateByValues"},{"$ref":"#/components/schemas/MetadataFieldValueUpdateByIds"}],"discriminator":{"propertyName":"type","mapping":{"BY_VALUES":"#/components/schemas/MetadataFieldValueUpdateByValues","BY_IDS":"#/components/schemas/MetadataFieldValueUpdateByIds"}}}},"components/schemas/OptionIdsByVariantFieldId":{"id":"components/schemas/OptionIdsByVariantFieldId","kind":"json-schema","title":"OptionIdsByVariantFieldId","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A map of product variant "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field.id"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to field options IDs for that field."},"children":[]}]}]}],"additionalProperties":{"type":"array","items":{"type":"string"}},"default":{},"example":{"3bb4e180-46df-4738-a836-6c2e1685dc2a":["0f85e50b-3b24-44e0-954d-22557fdfebc7","8f70afc5-6424-44f5-80e9-092204b7a30e"]}}},"components/schemas/OptionIdsByVariantFieldIdSet":{"id":"components/schemas/OptionIdsByVariantFieldIdSet","kind":"json-schema","title":"OptionIdsByVariantFieldIdSet","data":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alternative sets of product variant field values this criterion can match."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each item maps product variant "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field.id"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to matching values for that field. A product variant matches when it matches any map in this set. An empty array matches all variants for the product."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/OptionIdsByVariantFieldId"},"default":[],"example":[{"3bb4e180-46df-4738-a836-6c2e1685dc2a":["0f85e50b-3b24-44e0-954d-22557fdfebc7","8f70afc5-6424-44f5-80e9-092204b7a30e"]}]}},"components/schemas/AssetVariantCriterionBulkUpdateSetItem":{"id":"components/schemas/AssetVariantCriterionBulkUpdateSetItem","kind":"json-schema","title":"AssetVariantCriterionBulkUpdateSetItem","data":{"type":"object","required":["productId"],"properties":{"productId":{"description":"The unique ID of the product metadata record this criterion should match.","type":"string"},"optionIdsByVariantFieldId":{"$ref":"#/components/schemas/OptionIdsByVariantFieldIdSet"}}}},"components/schemas/AssetVariantCriterionBulkUpdate":{"id":"components/schemas/AssetVariantCriterionBulkUpdate","kind":"json-schema","title":"AssetVariantCriterionBulkUpdate","data":{"type":"object","description":"Fully replace each selected asset's variant criteria, creating them where none exist.","required":["operation","criteria"],"properties":{"operation":{"type":"string","enum":["SET"]},"criteria":{"description":"The replacement set of variant criteria for each selected asset. Each item associates the asset with one product.\n\nAn empty array removes all of the asset's variant criteria.\n","type":"array","items":{"$ref":"#/components/schemas/AssetVariantCriterionBulkUpdateSetItem"}}}}},"components/schemas/MetadataEditBatchRequest":{"id":"components/schemas/MetadataEditBatchRequest","kind":"json-schema","title":"MetadataEditBatchRequest","data":{"type":"object","required":["selector"],"properties":{"selector":{"$ref":"#/components/schemas/AssetsSelector"},"metadataFieldValueUpdates":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Metadata field value changes to apply to each selected asset. Defaults to no metadata field changes, allowing a request to only apply a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"variantCriterionUpdate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"array","default":[],"items":{"$ref":"#/components/schemas/MetadataFieldValueUpdate"}},"variantCriterionUpdate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Variant criteria change to apply to each selected asset. Omit or set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to leave each selected asset's variant criteria unchanged."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SET"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fully replaces each selected asset's variant criteria with the provided list, creating them where none exist. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REMOVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" deletes all of each selected asset's variant criteria and is a no-op for assets without any."},"children":[]}]}]}],"type":"object","nullable":true,"allOf":[{"$ref":"#/components/schemas/AssetVariantCriterionBulkUpdate"}]}}}},"components/schemas/NoResultJob":{"id":"components/schemas/NoResultJob","kind":"json-schema","title":"NoResultJob","data":{"oneOf":[{"$ref":"#/components/schemas/InProgressJob"},{"$ref":"#/components/schemas/CompletedJob"},{"$ref":"#/components/schemas/FailedJob"}],"discriminator":{"propertyName":"type","mapping":{"IN_PROGRESS":"#/components/schemas/InProgressJob","COMPLETED":"#/components/schemas/CompletedJob","FAILED":"#/components/schemas/FailedJob"}}}},"components/schemas/MetadataSuggestionBatchRequest":{"id":"components/schemas/MetadataSuggestionBatchRequest","kind":"json-schema","title":"MetadataSuggestionBatchRequest","data":{"type":"object","required":["selector"],"properties":{"selector":{"$ref":"#/components/schemas/AssetsSelector"}}}},"components/schemas/MetadataSuggestion":{"id":"components/schemas/MetadataSuggestion","kind":"json-schema","title":"MetadataSuggestion","data":{"type":"object","required":["values"],"properties":{"values":{"type":"object","additionalProperties":{"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":"Map of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field.id"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" keys to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"string[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the referenced "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field.multiValue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" then the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"string[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will contain "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the referenced "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field.multiValue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" then the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"string[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will contain "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0-1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The absence of an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field.id"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the map is equivalent to a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"string[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values. i.e. the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has no specified value for that "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field"},"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":"If the referenced "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field.hasFixedOptions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" then each item in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"string[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption.id"},"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":"The human-readable value can then be found in the referenced "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption.value"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the referenced "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field.hasFixedOptions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" then each item in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"string[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will itself be a human-readable value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Clients of the API are expected to retrieve the referenced "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" objects independently via the appropriate endpoints."},"children":[]}]}]}]}}}}},"components/schemas/MetadataSuggestionWithPermittedActions":{"id":"components/schemas/MetadataSuggestionWithPermittedActions","kind":"json-schema","title":"MetadataSuggestionWithPermittedActions","data":{"type":"object","required":["result","permittedActions"],"properties":{"result":{"$ref":"#/components/schemas/MetadataSuggestion"},"permittedActions":{"type":"array","items":{"$ref":"#/components/schemas/PermittedAction"}}}}},"components/schemas/MetadataSuggestionBatch":{"id":"components/schemas/MetadataSuggestionBatch","kind":"json-schema","title":"MetadataSuggestionBatch","data":{"type":"object","required":["successes"],"properties":{"successes":{"type":"object","description":"A map of successful results keyed on the asset ID","additionalProperties":{"$ref":"#/components/schemas/MetadataSuggestionWithPermittedActions"}}}}},"components/schemas/MetadataSuggestionCompletedJob":{"id":"components/schemas/MetadataSuggestionCompletedJob","kind":"json-schema","title":"MetadataSuggestionCompletedJob","data":{"allOf":[{"$ref":"#/components/schemas/CompletedJob"},{"type":"object","required":["result"],"properties":{"result":{"$ref":"#/components/schemas/MetadataSuggestionBatch"}}}]}},"components/schemas/MetadataSuggestionBatchJob":{"id":"components/schemas/MetadataSuggestionBatchJob","kind":"json-schema","title":"MetadataSuggestionBatchJob","data":{"oneOf":[{"$ref":"#/components/schemas/InProgressJob"},{"$ref":"#/components/schemas/MetadataSuggestionCompletedJob"},{"$ref":"#/components/schemas/FailedJob"}],"discriminator":{"propertyName":"type","mapping":{"IN_PROGRESS":"#/components/schemas/InProgressJob","COMPLETED":"#/components/schemas/MetadataSuggestionCompletedJob","FAILED":"#/components/schemas/FailedJob"}}}},"components/schemas/RejectedMetadataSuggestionRequest":{"id":"components/schemas/RejectedMetadataSuggestionRequest","kind":"json-schema","title":"RejectedMetadataSuggestionRequest","data":{"type":"object","required":["assetId","fieldId","value"],"properties":{"assetId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the suggestion is for"},"children":[]}]}]}],"example":"7af90a8b-7ccd-430f-a85d-e8614015bc47"},"fieldId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the suggestion is for"},"children":[]}]}]}],"example":"a52b5315-15b8-417f-b742-d6902108bac1"},"value":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value that was suggested and has now been rejected.  This will be the ID of a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption"},"children":[]}]}]}]}],"example":"1fc6d6c3-c42d-48ue2-b0db-5d680a58ca52"}}}},"components/schemas/RejectedMetadataSuggestionRequestItem":{"id":"components/schemas/RejectedMetadataSuggestionRequestItem","kind":"json-schema","title":"RejectedMetadataSuggestionRequestItem","data":{"allOf":[{"$ref":"#/components/schemas/BatchItem"},{"$ref":"#/components/schemas/RejectedMetadataSuggestionRequest"}]}},"components/schemas/RejectedMetadataSuggestionBatchRequest":{"id":"components/schemas/RejectedMetadataSuggestionBatchRequest","kind":"json-schema","title":"RejectedMetadataSuggestionBatchRequest","data":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/RejectedMetadataSuggestionRequestItem"}}}}},"components/schemas/RejectedMetadataSuggestion":{"id":"components/schemas/RejectedMetadataSuggestion","kind":"json-schema","title":"RejectedMetadataSuggestion","data":{"type":"object","required":["id","assetId","fieldId","value"],"properties":{"id":{"type":"string","description":"The unique identifier for this Rejected Metadata Suggestion","example":"9ca10283-b2a5-44aa-93b5-376644746170"},"assetId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the suggestion is for"},"children":[]}]}]}],"example":"7af90a8b-7ccd-430f-a85d-e8614015bc47"},"fieldId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the suggestion is for"},"children":[]}]}]}],"example":"a52b5315-15b8-417f-b742-d6902108bac1"},"value":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value that was suggested and has now been rejected.  This will be the ID of a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption"},"children":[]}]}]}]}],"example":"1fc6d6c3-c42d-48ue2-b0db-5d680a58ca52"}}}},"components/schemas/RejectedMetadataSuggestionWithPermittedActions":{"id":"components/schemas/RejectedMetadataSuggestionWithPermittedActions","kind":"json-schema","title":"RejectedMetadataSuggestionWithPermittedActions","data":{"type":"object","required":["result","permittedActions"],"properties":{"result":{"$ref":"#/components/schemas/RejectedMetadataSuggestion"},"permittedActions":{"type":"array","items":{"$ref":"#/components/schemas/PermittedAction"}}}}},"components/schemas/RejectedMetadataSuggestionBatch":{"id":"components/schemas/RejectedMetadataSuggestionBatch","kind":"json-schema","title":"RejectedMetadataSuggestionBatch","data":{"type":"object","required":["successes"],"properties":{"successes":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A map of successful results keyed on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"batchItemId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" provided in the request"},"children":[]}]}]}],"additionalProperties":{"$ref":"#/components/schemas/RejectedMetadataSuggestionWithPermittedActions"}}}}},"components/schemas/LifecycleTransition":{"id":"components/schemas/LifecycleTransition","kind":"json-schema","title":"LifecycleTransition","data":{"type":"string","description":"The transition. Generally describe the state moving from and to.","enum":["STAGED_TO_PENDING_APPROVAL","STAGED_TO_LIVE","PENDING_APPROVAL_TO_LIVE","LIVE_TO_BINNED","BINNED_TO_LIVE"]}},"components/schemas/LifecycleTransitionBatchRequest":{"id":"components/schemas/LifecycleTransitionBatchRequest","kind":"json-schema","title":"LifecycleTransitionBatchRequest","data":{"type":"object","properties":{"selector":{"$ref":"#/components/schemas/AssetsSelector"},"transition":{"$ref":"#/components/schemas/LifecycleTransition"}}}},"components/schemas/AssetDeletionBatchRequest":{"id":"components/schemas/AssetDeletionBatchRequest","kind":"json-schema","title":"AssetDeletionBatchRequest","data":{"type":"object","required":["selector"],"properties":{"selector":{"$ref":"#/components/schemas/AssetsSelector"}}}},"components/schemas/CropParameters":{"id":"components/schemas/CropParameters","kind":"json-schema","title":"CropParameters","data":{"type":"object","required":["x","y","width","height"],"properties":{"x":{"type":"integer","description":"The x coordinate of the top left corner of the crop","example":200},"y":{"type":"integer","description":"The y coordinate of the top left corner of the crop","example":100},"width":{"type":"integer","description":"The width of the crop's bounding box","example":400},"height":{"type":"integer","description":"The height of the crop's bounding box","example":300}}}},"components/schemas/SavedCropAreaRequest":{"id":"components/schemas/SavedCropAreaRequest","kind":"json-schema","title":"SavedCropAreaRequest","data":{"type":"object","required":["presetId","cropParameters","previewUri"],"properties":{"presetId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID for a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Preset-Transformations"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PresetTransformation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It only applies to CropTransformation presets."},"children":[]}]}]}]},"cropParameters":{"$ref":"#/components/schemas/CropParameters"},"previewUri":{"type":"string","description":"The preview of this crop area in Base64"}}}},"components/schemas/SavedCropAreaSummary":{"id":"components/schemas/SavedCropAreaSummary","kind":"json-schema","title":"SavedCropAreaSummary","data":{"type":"object","required":["id","presetId","assetId","cropParameters"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Asset-Saved-Crop-Areas"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SavedCropArea"},"children":[]}]}]}]}]},"presetId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID for a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Preset-Transformations"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PresetTransformation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It only applies to CropTransformation presets."},"children":[]}]}]}]},"assetId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID for the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]}]}]}]},"cropParameters":{"$ref":"#/components/schemas/CropParameters"}}}},"components/schemas/SavedCropArea":{"id":"components/schemas/SavedCropArea","kind":"json-schema","title":"SavedCropArea","data":{"allOf":[{"$ref":"#/components/schemas/SavedCropAreaSummary"},{"type":"object","required":["previewUri"],"properties":{"previewUri":{"type":"string","description":"The preview of this crop area in Base64"}}}]}},"components/schemas/SavedCropAreaWithPermittedActions":{"id":"components/schemas/SavedCropAreaWithPermittedActions","kind":"json-schema","title":"SavedCropAreaWithPermittedActions","data":{"type":"object","required":["result","permittedActions"],"properties":{"result":{"$ref":"#/components/schemas/SavedCropArea"},"permittedActions":{"type":"array","items":{"$ref":"#/components/schemas/PermittedAction"}}}}},"components/schemas/SavedCropAreaSummaryWithPermittedActions":{"id":"components/schemas/SavedCropAreaSummaryWithPermittedActions","kind":"json-schema","title":"SavedCropAreaSummaryWithPermittedActions","data":{"type":"object","required":["result","permittedActions"],"properties":{"result":{"$ref":"#/components/schemas/SavedCropAreaSummary"},"permittedActions":{"type":"array","items":{"$ref":"#/components/schemas/PermittedAction"}}}}},"components/schemas/ContextType":{"id":"components/schemas/ContextType","kind":"json-schema","title":"ContextType","data":{"type":"string","enum":["APPROVAL","COLLECTION"],"description":"The type of context the comment is in","example":"APPROVAL"}},"components/schemas/Comment":{"id":"components/schemas/Comment","kind":"json-schema","title":"Comment","data":{"type":"object","required":["id","accountId","userId","assetId","contextType","contextId","text","dateCreated"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID for the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Asset-Comments"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Comment"},"children":[]}]}]}]}],"example":"8bc23748-39e0-4dce-a48e-f71845eeeec3"},"accountId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Asset-Comments"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Comment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" belongs to"},"children":[]}]}]}],"type":"string","example":"cfb665ca-ce35-4418-b9d5-70ee815db4bd"},"userId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Users"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" who created this "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Asset-Comments"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Comment"},"children":[]}]}]}]}],"type":"string","example":"google-oauth2|110955770826801837334"},"assetId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" this "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Asset-Comments"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Comment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" belongs to"},"children":[]}]}]}],"example":"7af90a8b-7ccd-430f-a85d-e8614015bc47"},"contextType":{"$ref":"#/components/schemas/ContextType"},"contextId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifies which context this "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Asset-Comments"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Comment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" should be shown in"},"children":[]}]}]}],"example":"collection/a52b5315-15b8-417f-b742-d6902108bac1"},"text":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The text content of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Asset-Comments"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Comment"},"children":[]}]}]}]}],"example":"This is a comment that has been left by a user, how insightful!","maxLength":4000},"dateCreated":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The datetime the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Asset-Comments"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Comment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was created in ISO datetime format"},"children":[]}]}]}],"example":"2021-02-17T09:24:01.417Z"}}}},"components/schemas/CommentWithPermittedActions":{"id":"components/schemas/CommentWithPermittedActions","kind":"json-schema","title":"CommentWithPermittedActions","data":{"type":"object","required":["result","permittedActions"],"properties":{"result":{"$ref":"#/components/schemas/Comment"},"permittedActions":{"type":"array","items":{"$ref":"#/components/schemas/PermittedAction"}}}}},"components/schemas/CommentRequest":{"id":"components/schemas/CommentRequest","kind":"json-schema","title":"CommentRequest","data":{"type":"object","required":["contextId","text"],"properties":{"contextId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifies which context this "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Asset-Comments"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Comment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" should be shown in"},"children":[]}]}]}],"example":"collection/a52b5315-15b8-417f-b742-d6902108bac1"},"contextType":{"$ref":"#/components/schemas/ContextType"},"text":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The text content of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Asset-Comments"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Comment"},"children":[]}]}]}]}],"example":"This is a comment that has been left by a user, how insightful!","maxLength":4000}}}},"components/schemas/AssetDeduplicationResult":{"id":"components/schemas/AssetDeduplicationResult","kind":"json-schema","title":"AssetDeduplicationResult","data":{"type":"object","required":["deduplicatedAssetCount"],"properties":{"deduplicatedAssetCount":{"type":"integer","description":"The number of duplicate assets that were deleted","example":42}}}},"components/schemas/AssetDeduplicationCompletedJob":{"id":"components/schemas/AssetDeduplicationCompletedJob","kind":"json-schema","title":"AssetDeduplicationCompletedJob","data":{"allOf":[{"$ref":"#/components/schemas/CompletedJob"},{"type":"object","required":["result"],"properties":{"result":{"$ref":"#/components/schemas/AssetDeduplicationResult"}}}]}},"components/schemas/AssetDeduplicationBatchJob":{"id":"components/schemas/AssetDeduplicationBatchJob","kind":"json-schema","title":"AssetDeduplicationBatchJob","data":{"oneOf":[{"$ref":"#/components/schemas/InProgressJob"},{"$ref":"#/components/schemas/AssetDeduplicationCompletedJob"},{"$ref":"#/components/schemas/FailedJob"}],"discriminator":{"propertyName":"type","mapping":{"IN_PROGRESS":"#/components/schemas/InProgressJob","COMPLETED":"#/components/schemas/AssetDeduplicationCompletedJob","FAILED":"#/components/schemas/FailedJob"}}}},"components/schemas/MetadataExportResult":{"id":"components/schemas/MetadataExportResult","kind":"json-schema","title":"MetadataExportResult","data":{"type":"object","properties":{"downloadUrl":{"type":"string","description":"URL to download the CSV file containing the exported metadata","example":"https://csv-url-example.here"}}}},"components/schemas/MetadataExportCompletedJob":{"id":"components/schemas/MetadataExportCompletedJob","kind":"json-schema","title":"MetadataExportCompletedJob","data":{"allOf":[{"$ref":"#/components/schemas/CompletedJob"},{"type":"object","required":["result"],"properties":{"result":{"$ref":"#/components/schemas/MetadataExportResult"}}}]}},"components/schemas/MetadataExportBatchJob":{"id":"components/schemas/MetadataExportBatchJob","kind":"json-schema","title":"MetadataExportBatchJob","data":{"oneOf":[{"$ref":"#/components/schemas/InProgressJob"},{"$ref":"#/components/schemas/MetadataExportCompletedJob"},{"$ref":"#/components/schemas/FailedJob"}],"discriminator":{"propertyName":"type","mapping":{"IN_PROGRESS":"#/components/schemas/InProgressJob","COMPLETED":"#/components/schemas/MetadataExportCompletedJob","FAILED":"#/components/schemas/FailedJob"}}}},"components/schemas/JobPatchRequest":{"id":"components/schemas/JobPatchRequest","kind":"json-schema","title":"JobPatchRequest","data":{"type":"object","required":["status"],"properties":{"status":{"type":"string","nullable":true,"description":"The status of the job","enum":["STARTED","STOPPED"]}}}},"components/schemas/SavedCropAreaPatchRequest":{"id":"components/schemas/SavedCropAreaPatchRequest","kind":"json-schema","title":"SavedCropAreaPatchRequest","data":{"type":"object","properties":{"cropParameters":{"$ref":"#/components/schemas/CropParameters"},"previewUri":{"type":"string","description":"The preview of this crop area in Base64"}}}},"components/schemas/SavedCropAreaSummarySearchField":{"id":"components/schemas/SavedCropAreaSummarySearchField","kind":"json-schema","title":"SavedCropAreaSummarySearchField","data":{"type":"string","enum":["PRESET_ID","ASSET_ID"],"example":"PRESET_ID","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Asset-Saved-Crop-Area-Summaries"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SavedCropAreaSummary"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property value"},"children":[]}]}]}]}},"components/schemas/SavedCropAreaSummaryFieldEqualsSearchCriterion":{"id":"components/schemas/SavedCropAreaSummaryFieldEqualsSearchCriterion","kind":"json-schema","title":"SavedCropAreaSummaryFieldEqualsSearchCriterion","data":{"allOf":[{"$ref":"#/components/schemas/FieldEqualsSearchCriterion"},{"type":"object","required":["type","field"],"properties":{"type":{"type":"string","enum":["FIELD_EQUALS"]},"field":{"$ref":"#/components/schemas/SavedCropAreaSummarySearchField"}}}]}},"components/schemas/SavedCropAreaSummaryFieldInSearchCriterion":{"id":"components/schemas/SavedCropAreaSummaryFieldInSearchCriterion","kind":"json-schema","title":"SavedCropAreaSummaryFieldInSearchCriterion","data":{"allOf":[{"$ref":"#/components/schemas/FieldInSearchCriterion"},{"type":"object","required":["type","field"],"properties":{"type":{"type":"string","enum":["FIELD_IN"]},"field":{"$ref":"#/components/schemas/SavedCropAreaSummarySearchField"}}}]}},"components/schemas/SavedCropAreaSummarySearchCriterion":{"id":"components/schemas/SavedCropAreaSummarySearchCriterion","kind":"json-schema","title":"SavedCropAreaSummarySearchCriterion","data":{"oneOf":[{"$ref":"#/components/schemas/SavedCropAreaSummaryFieldEqualsSearchCriterion"},{"$ref":"#/components/schemas/SavedCropAreaSummaryFieldInSearchCriterion"},{"$ref":"#/components/schemas/SavedCropAreaSummaryAndSearchCriterion"}],"discriminator":{"propertyName":"type","mapping":{"FIELD_EQUALS":"#/components/schemas/SavedCropAreaSummaryFieldEqualsSearchCriterion","FIELD_IN":"#/components/schemas/SavedCropAreaSummaryFieldInSearchCriterion","AND":"#/components/schemas/SavedCropAreaSummaryAndSearchCriterion"}}}},"components/schemas/SavedCropAreaSummaryAndSearchCriterion":{"id":"components/schemas/SavedCropAreaSummaryAndSearchCriterion","kind":"json-schema","title":"SavedCropAreaSummaryAndSearchCriterion","data":{"allOf":[{"$ref":"#/components/schemas/SearchCriterion"},{"type":"object","required":["type","criteria"],"properties":{"type":{"type":"string","enum":["AND"]},"criteria":{"type":"array","description":"The list of criteria to AND together","items":{"$ref":"#/components/schemas/SavedCropAreaSummarySearchCriterion"}}}}]}},"components/schemas/SavedCropAreaSummarySort":{"id":"components/schemas/SavedCropAreaSummarySort","kind":"json-schema","title":"SavedCropAreaSummarySort","data":{"type":"object","required":["field","order"],"properties":{"field":{"$ref":"#/components/schemas/SavedCropAreaSummarySearchField"},"order":{"$ref":"#/components/schemas/SortOrder"}}}},"components/schemas/SavedCropAreaSummarySearchRequest":{"id":"components/schemas/SavedCropAreaSummarySearchRequest","kind":"json-schema","title":"SavedCropAreaSummarySearchRequest","data":{"allOf":[{"$ref":"#/components/schemas/BasePaginatedSearchInAccountRequest"},{"type":"object","required":["criterion","sorts"],"properties":{"criterion":{"description":"The search criterion","$ref":"#/components/schemas/SavedCropAreaSummarySearchCriterion"},"sorts":{"description":"Sorts to be applied to the search in order of precedence","type":"array","items":{"$ref":"#/components/schemas/SavedCropAreaSummarySort"}}}}]}},"components/schemas/SavedCropAreaSummarySearch":{"id":"components/schemas/SavedCropAreaSummarySearch","kind":"json-schema","title":"SavedCropAreaSummarySearch","data":{"type":"object","required":["results","totalResults"],"properties":{"results":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The specified page of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Asset-Saved-Crop-Area-Summaries"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SavedCropAreaSummary"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources which match the search criterion"},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/SavedCropAreaSummaryWithPermittedActions"}},"totalResults":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total number of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Asset-Saved-Crop-Area-Summaries"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SavedCropAreaSummary"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources which match the search criterion"},"children":[]}]}]}],"example":15}}}},"components/schemas/AssetVariantCriterion":{"id":"components/schemas/AssetVariantCriterion","kind":"json-schema","title":"AssetVariantCriterion","data":{"type":"object","required":["id","accountId","assetId","productId","optionIdsByVariantFieldId"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Asset-Variant-Criteria"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetVariantCriterion"},"children":[]}]}]}]}],"example":"e5e4b297-29e7-4a78-8f9f-97f7a02df8df"},"accountId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the account the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Asset-Variant-Criteria"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetVariantCriterion"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" belongs to"},"children":[]}]}]}],"example":"2d8f0349-4e9c-4df5-bd4d-8c96e4f91851"},"assetId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the asset metadata record this "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Asset-Variant-Criteria"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetVariantCriterion"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" belongs to"},"children":[]}]}]}],"example":"2807728f-2c48-422b-a7a8-f9adee425f32"},"productId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the product metadata record this "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Asset-Variant-Criteria"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetVariantCriterion"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" belongs to"},"children":[]}]}]}],"example":"54f26d2c-ae22-4185-81b4-ae8b947d4d8f"},"optionIdsByVariantFieldId":{"$ref":"#/components/schemas/OptionIdsByVariantFieldIdSet"}}}},"components/schemas/AssetVariantCriterionWithPermittedActions":{"id":"components/schemas/AssetVariantCriterionWithPermittedActions","kind":"json-schema","title":"AssetVariantCriterionWithPermittedActions","data":{"type":"object","required":["result","permittedActions"],"properties":{"result":{"$ref":"#/components/schemas/AssetVariantCriterion"},"permittedActions":{"type":"array","items":{"$ref":"#/components/schemas/PermittedAction"}}}}},"components/schemas/AssetVariantCriterionSearchField":{"id":"components/schemas/AssetVariantCriterionSearchField","kind":"json-schema","title":"AssetVariantCriterionSearchField","data":{"type":"string","enum":["ID","ASSET_ID"],"example":"ASSET_ID"}},"components/schemas/AssetVariantCriterionFieldEqualsSearchCriterion":{"id":"components/schemas/AssetVariantCriterionFieldEqualsSearchCriterion","kind":"json-schema","title":"AssetVariantCriterionFieldEqualsSearchCriterion","data":{"allOf":[{"$ref":"#/components/schemas/FieldEqualsSearchCriterion"},{"type":"object","required":["type","field"],"properties":{"type":{"type":"string","enum":["FIELD_EQUALS"]},"field":{"$ref":"#/components/schemas/AssetVariantCriterionSearchField"}}}]}},"components/schemas/AssetVariantCriterionFieldInSearchCriterion":{"id":"components/schemas/AssetVariantCriterionFieldInSearchCriterion","kind":"json-schema","title":"AssetVariantCriterionFieldInSearchCriterion","data":{"allOf":[{"$ref":"#/components/schemas/FieldInSearchCriterion"},{"type":"object","required":["type","field"],"properties":{"type":{"type":"string","enum":["FIELD_IN"]},"field":{"$ref":"#/components/schemas/AssetVariantCriterionSearchField"}}}]}},"components/schemas/AssetVariantCriterionSearchCriterion":{"id":"components/schemas/AssetVariantCriterionSearchCriterion","kind":"json-schema","title":"AssetVariantCriterionSearchCriterion","data":{"oneOf":[{"$ref":"#/components/schemas/AssetVariantCriterionFieldEqualsSearchCriterion"},{"$ref":"#/components/schemas/AssetVariantCriterionFieldInSearchCriterion"}],"discriminator":{"propertyName":"type","mapping":{"FIELD_EQUALS":"#/components/schemas/AssetVariantCriterionFieldEqualsSearchCriterion","FIELD_IN":"#/components/schemas/AssetVariantCriterionFieldInSearchCriterion"}}}},"components/schemas/AssetVariantCriterionSortField":{"id":"components/schemas/AssetVariantCriterionSortField","kind":"json-schema","title":"AssetVariantCriterionSortField","data":{"type":"string","enum":["ID"],"example":"ID","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Asset-Variant-Criteria"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetVariantCriterion"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property value, the default is ID"},"children":[]}]}]}]}},"components/schemas/AssetVariantCriterionSort":{"id":"components/schemas/AssetVariantCriterionSort","kind":"json-schema","title":"AssetVariantCriterionSort","data":{"type":"object","properties":{"field":{"$ref":"#/components/schemas/AssetVariantCriterionSortField"},"order":{"$ref":"#/components/schemas/SortOrder"}}}},"components/schemas/AssetVariantCriterionSearchRequest":{"id":"components/schemas/AssetVariantCriterionSearchRequest","kind":"json-schema","title":"AssetVariantCriterionSearchRequest","data":{"allOf":[{"$ref":"#/components/schemas/BasePaginatedSearchInAccountRequest"},{"type":"object","required":["criterion"],"properties":{"criterion":{"description":"The search criterion","$ref":"#/components/schemas/AssetVariantCriterionSearchCriterion"},"sorts":{"description":"Sorts to be applied to the search in order of precedence","type":"array","items":{"$ref":"#/components/schemas/AssetVariantCriterionSort"}}}}]}},"components/schemas/AssetVariantCriterionSearch":{"id":"components/schemas/AssetVariantCriterionSearch","kind":"json-schema","title":"AssetVariantCriterionSearch","data":{"type":"object","required":["results","totalResults"],"properties":{"results":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The specified page of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Asset-Variant-Criteria"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetVariantCriterion"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources which match the search criterion"},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/AssetVariantCriterionWithPermittedActions"}},"totalResults":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total number of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Asset-Variant-Criteria"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetVariantCriterion"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources which match the search criterion"},"children":[]}]}]}],"example":15}}}},"components/schemas/AssetPermittedActionsWithDefault":{"id":"components/schemas/AssetPermittedActionsWithDefault","kind":"json-schema","title":"AssetPermittedActionsWithDefault","data":{"type":"string","enum":["VIEW","VIEW_AND_DOWNLOAD"],"example":"VIEW","default":"VIEW_AND_DOWNLOAD","description":"Permissions users have on assets they are viewing"}},"components/schemas/AssetShareRequest":{"id":"components/schemas/AssetShareRequest","kind":"json-schema","title":"AssetShareRequest","data":{"type":"object","required":["assetIds","expiry"],"properties":{"assetIds":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The set of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" identifiers that have been shared"},"children":[]}]}]}],"type":"array","items":{"type":"string"},"example":["7af90a8b-7ccd-430f-a85d-e8614015bc47","024e1b06-4bda-4630-a788-8063a5b9df85"]},"expiry":{"type":"string","nullable":true,"format":"date-time","description":"The datetime the share will expire and no longer be accessible in ISO datetime format. If the expiry is null, the share will never expire.","example":"2021-02-17T09:24:01.417Z"},"assetPermittedActions":{"$ref":"#/components/schemas/AssetPermittedActionsWithDefault"}}}},"components/schemas/AdminPermissions":{"id":"components/schemas/AdminPermissions","kind":"json-schema","title":"AdminPermissions","data":{"type":"object","required":["permissionsType"],"properties":{"permissionsType":{"type":"string","enum":["ADMIN"]}}}},"components/schemas/GroupRole":{"id":"components/schemas/GroupRole","kind":"json-schema","title":"GroupRole","data":{"description":"The role of users in this group","type":"string","example":"BASIC","enum":["BASIC","CONTRIBUTOR"]}},"components/schemas/FieldWhitelistAllOptions":{"id":"components/schemas/FieldWhitelistAllOptions","kind":"json-schema","title":"FieldWhitelistAllOptions","data":{"type":"object","required":["fieldWhitelistType"],"properties":{"fieldWhitelistType":{"type":"string","enum":["ALL_OPTIONS"]}}}},"components/schemas/FieldWhitelistSpecificOptions":{"id":"components/schemas/FieldWhitelistSpecificOptions","kind":"json-schema","title":"FieldWhitelistSpecificOptions","data":{"type":"object","required":["fieldWhitelistType","fieldOptionIds"],"properties":{"fieldWhitelistType":{"type":"string","enum":["SPECIFIC_OPTIONS"]},"fieldOptionIds":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources that are whitelisted"},"children":[]}]}]}],"type":"array","items":{"type":"string"}}}}},"components/schemas/FieldWhitelist":{"id":"components/schemas/FieldWhitelist","kind":"json-schema","title":"FieldWhitelist","data":{"oneOf":[{"$ref":"#/components/schemas/FieldWhitelistAllOptions"},{"$ref":"#/components/schemas/FieldWhitelistSpecificOptions"}],"discriminator":{"propertyName":"fieldWhitelistType","mapping":{"ALL_OPTIONS":"#/components/schemas/FieldWhitelistAllOptions","SPECIFIC_OPTIONS":"#/components/schemas/FieldWhitelistSpecificOptions"}}}},"components/schemas/Group":{"id":"components/schemas/Group","kind":"json-schema","title":"Group","data":{"type":"object","required":["id","accountId","name","role","numberOfUsers","fieldWhitelist"],"properties":{"id":{"description":"The unique ID of group","type":"string","example":"cfb665ca-ce35-4418-b9d5-70ee815db4bd"},"accountId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the group belongs to"},"children":[]}]}]}],"type":"string","example":"cfb665ca-ce35-4418-b9d5-70ee815db4bd"},"name":{"description":"The name of the group","type":"string","example":"My Group Name"},"role":{"$ref":"#/components/schemas/GroupRole"},"numberOfUsers":{"description":"The number of users in the group","example":56,"type":"integer"},"fieldWhitelist":{"$ref":"#/components/schemas/FieldWhitelist"}}}},"components/schemas/InGroupsPermissions":{"id":"components/schemas/InGroupsPermissions","kind":"json-schema","title":"InGroupsPermissions","data":{"type":"object","required":["permissionsType","requiresUploadApproval","canApprove","canAddPortals","groups"],"properties":{"permissionsType":{"type":"string","enum":["IN_GROUPS"]},"requiresUploadApproval":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Users"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'s uploads require approval"},"children":[]}]}]}],"type":"boolean","example":true},"canApprove":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Users"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can approve assets"},"children":[]}]}]}],"type":"boolean","example":true},"canAddPortals":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Users"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can create and manage portals they created"},"children":[]}]}]}],"type":"boolean","example":true},"groups":{"type":"array","items":{"$ref":"#/components/schemas/Group"}}}}},"components/schemas/UserPermissions":{"id":"components/schemas/UserPermissions","kind":"json-schema","title":"UserPermissions","data":{"oneOf":[{"$ref":"#/components/schemas/AdminPermissions"},{"$ref":"#/components/schemas/InGroupsPermissions"}],"discriminator":{"propertyName":"permissionsType","mapping":{"ADMIN":"#/components/schemas/AdminPermissions","IN_GROUPS":"#/components/schemas/InGroupsPermissions"}}}},"components/schemas/ActiveAccountUser":{"id":"components/schemas/ActiveAccountUser","kind":"json-schema","title":"ActiveAccountUser","data":{"type":"object","required":["type","accountId","id","email","permissions","hasUploadedProfilePicture"],"properties":{"type":{"type":"string","enum":["ACTIVE_ACCOUNT_USER"]},"accountId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Users"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" belongs to"},"children":[]}]}]}],"type":"string","example":"cfb665ca-ce35-4418-b9d5-70ee815db4bd"},"id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Users"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]}]}]}]}],"type":"string","example":"google-oauth2|110955770826801837334"},"email":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The email address of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Users"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]}]}]}]}],"type":"string","example":"john.smith@gmail.com"},"permissions":{"$ref":"#/components/schemas/UserPermissions"},"name":{"description":"The full name of the user.","type":"string","nullable":true,"example":"Ken Hassleback"},"firstName":{"description":"The first name of the user","type":"string","nullable":true,"example":"Ken"},"lastName":{"description":"The last name of the user","type":"string","nullable":true,"example":"Hassleback"},"picture":{"description":"A URL for the profile picture of the user, if they have one","example":"https://example.com/john-smith-picture.jpg","type":"string","nullable":true},"hasUploadedProfilePicture":{"description":"Whether the profile picture is a Dash-managed upload.","type":"boolean","example":true},"lastLogin":{"type":"string","nullable":true,"format":"date-time","description":"The datetime the user last logged in, in ISO offset format","example":"2021-02-16T16:21:58.640+00:00"}}}},"components/schemas/PendingAccountUser":{"id":"components/schemas/PendingAccountUser","kind":"json-schema","title":"PendingAccountUser","data":{"type":"object","required":["type","accountId","email","permissions"],"properties":{"type":{"type":"string","enum":["PENDING_ACCOUNT_USER"]},"accountId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Users"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" belongs to"},"children":[]}]}]}],"type":"string","example":"cfb665ca-ce35-4418-b9d5-70ee815db4bd"},"email":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The email address of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Users"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]}]}]}]}],"type":"string","example":"john.smith@gmail.com"},"permissions":{"$ref":"#/components/schemas/UserPermissions"}}}},"components/schemas/PortalUser":{"id":"components/schemas/PortalUser","kind":"json-schema","title":"PortalUser","data":{"type":"object","required":["type","accountId","id"],"properties":{"type":{"type":"string","enum":["PORTAL_USER"]},"accountId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Users"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" belongs to"},"children":[]}]}]}],"type":"string","example":"cfb665ca-ce35-4418-b9d5-70ee815db4bd"},"id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Users"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]}]}]}]}],"type":"string","example":"google-oauth2|110955770826801837334"}}}},"components/schemas/ExternalAccessUser":{"id":"components/schemas/ExternalAccessUser","kind":"json-schema","title":"ExternalAccessUser","data":{"type":"object","required":["type","accountId","id"],"properties":{"type":{"type":"string","enum":["EXTERNAL_ACCESS_USER"]},"accountId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Users"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" belongs to"},"children":[]}]}]}],"type":"string","example":"cfb665ca-ce35-4418-b9d5-70ee815db4bd"},"id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Users"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]}]}]}]}],"type":"string","example":"google-oauth2|110955770826801837334"}}}},"components/schemas/GuestUploadUser":{"id":"components/schemas/GuestUploadUser","kind":"json-schema","title":"GuestUploadUser","data":{"type":"object","required":["type","accountId","id","email"],"properties":{"type":{"type":"string","enum":["GUEST_UPLOAD_USER"]},"accountId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Users"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" belongs to"},"children":[]}]}]}],"type":"string","example":"cfb665ca-ce35-4418-b9d5-70ee815db4bd"},"id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Users"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]}]}]}]}],"type":"string","example":"google-oauth2|110955770826801837334"},"email":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The email address of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Users"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]}]}]}]}],"type":"string","example":"john.smith@gmail.com"}}}},"components/schemas/User":{"id":"components/schemas/User","kind":"json-schema","title":"User","data":{"oneOf":[{"$ref":"#/components/schemas/ActiveAccountUser"},{"$ref":"#/components/schemas/PendingAccountUser"},{"$ref":"#/components/schemas/PortalUser"},{"$ref":"#/components/schemas/ExternalAccessUser"},{"$ref":"#/components/schemas/GuestUploadUser"}],"discriminator":{"propertyName":"type","mapping":{"ACTIVE_ACCOUNT_USER":"#/components/schemas/ActiveAccountUser","PENDING_ACCOUNT_USER":"#/components/schemas/PendingAccountUser","PORTAL_USER":"#/components/schemas/PortalUser","EXTERNAL_ACCESS_USER":"#/components/schemas/ExternalAccessUser","GUEST_UPLOAD_USER":"#/components/schemas/GuestUploadUser"}}}},"components/schemas/AssetPermittedActions":{"id":"components/schemas/AssetPermittedActions","kind":"json-schema","title":"AssetPermittedActions","data":{"type":"string","enum":["VIEW","VIEW_AND_DOWNLOAD"],"example":"VIEW","description":"Permissions users have on assets they are viewing"}},"components/schemas/AssetShare":{"id":"components/schemas/AssetShare","kind":"json-schema","title":"AssetShare","data":{"type":"object","required":["id","accountId","assetIds","expiry","assetPermittedActions","valid"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID for the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Asset-Shares"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetShare"},"children":[]}]}]}]}],"example":"4517a7ba-a482-4211-b97e-f4256f53fd32"},"accountId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Asset-Shares"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetShare"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" belongs to"},"children":[]}]}]}],"type":"string","example":"cfb665ca-ce35-4418-b9d5-70ee815db4bd"},"author":{"description":"The details of the user who authored the share, or null if the user no longer exists","nullable":true,"$ref":"#/components/schemas/User"},"assetIds":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The set of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" identifiers that have been shared"},"children":[]}]}]}],"type":"array","items":{"type":"string"},"example":["7af90a8b-7ccd-430f-a85d-e8614015bc47","024e1b06-4bda-4630-a788-8063a5b9df85"]},"expiry":{"type":"string","nullable":true,"format":"date-time","description":"The datetime the share will expire and no longer be accessible in ISO datetime format. If the expiry is null, the share will never expire.","example":"2021-02-17T09:24:01.417Z"},"assetPermittedActions":{"$ref":"#/components/schemas/AssetPermittedActions"},"valid":{"type":"boolean","example":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Asset-Shares"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetShare"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is still valid/accessible"},"children":[]}]}]}]}}}},"components/schemas/AssetShareWithPermittedActions":{"id":"components/schemas/AssetShareWithPermittedActions","kind":"json-schema","title":"AssetShareWithPermittedActions","data":{"type":"object","required":["result","permittedActions"],"properties":{"result":{"$ref":"#/components/schemas/AssetShare"},"permittedActions":{"type":"array","items":{"$ref":"#/components/schemas/PermittedAction"}}}}},"components/schemas/NullableDateTimePatch":{"id":"components/schemas/NullableDateTimePatch","kind":"json-schema","title":"NullableDateTimePatch","data":{"type":"object","properties":{"value":{"description":"The new value for the datetime in ISO format, e.g. 2021-02-17T09:24:01.417Z","type":"string","format":"date-time","nullable":true,"example":"2021-02-17T09:24:01.417Z"}}}},"components/schemas/AssetSharePatchRequest":{"id":"components/schemas/AssetSharePatchRequest","kind":"json-schema","title":"AssetSharePatchRequest","data":{"type":"object","properties":{"expiry":{"$ref":"#/components/schemas/NullableDateTimePatch"},"assetPermittedActions":{"$ref":"#/components/schemas/AssetPermittedActions"}}}},"components/schemas/AccessToken":{"id":"components/schemas/AccessToken","kind":"json-schema","title":"AccessToken","data":{"type":"object","required":["accessToken"],"properties":{"accessToken":{"type":"string","description":"A JWT access token which can be used to access Dash","example":"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6Ik5UZzNPRFV4TkVKQk56UTVRemswTjBFNFFUTTJOVUV6TlRnNU9VVXpRakU0UmtKQlJrSXpOUSJ9.eyJodHRwczovL2Fzc2V0cGxhdGZvcm0uaW8vYWNjb3VudF9pZCI6IjE3ZmNhYzg5LWNjMmUtNGE0MC1hYTZmLWI4NWQ4MDEzMDRkMyIsImh0dHBzOi8vYXNzZXRwbGF0Zm9ybS5pby9leHRlcm5hbF9hY2Nlc3NfaWQiOiI4NjVjNjBiYi02NzA5LTQxZTAtOGI0ZS0yNTljYTk4MjkzNTEiLCJodHRwczovL2Fzc2V0cGxhdGZvcm0uaW8vZXh0ZXJuYWxfYWNjZXNzX3Jlc291cmNlX3R5cGUiOiJTSEFSRSIsImh0dHBzOi8vYXNzZXRwbGF0Zm9ybS5pby9zY29wZSI6ImFjY2VzczpleHRlcm5hbF9hY2Nlc3MiLCJodHRwczovL2Fzc2V0cGxhdGZvcm0uaW8vdGVtcG9yYXJ5X3VzZXJfaWQiOiJ0ZW1wb3JhcnktdXNlci1mb3ItZXh0ZXJuYWwtYWNjZXNzfDg2NWM2MGJiLTY3MDktNDFlMC04YjRlLTI1OWNhOTgyOTM1MXxTSEFSRXxmMDJmNTE2Mi03OTc4LTRhMzktYWZkMS0zZGU1MzY1ODlmNDkiLCJpc3MiOiJodHRwczovL2xvZ2luLmJyaWdodGRhc2hzdGFnaW5nLmFwcC8iLCJzdWIiOiJWNFhJdWN1eEx5UzFmNjVkd2RmaWRib1BLcnFFb3lkWUBjbGllbnRzIiwiYXVkIjoiaHR0cHM6Ly9hc3NldHBzdGFnaW5nLmlvIiwiaWF0IjoxNjIwMTIzMjgyLCJleHAiOjE2MjAyMDk2ODIsImF6cCI6IlY0WEl1Y3V4THlTMWY2NWR3ZGZpZGJvUEtycUVveWRZIiwiZ3R5IjoiY2xpZW50LWNyZWRlbnRpYWxzIn0.clGEEfy-8yQNQ_f4TDc0OqA8Zi5gHq_-9gKFRif69DNnhzIbgqduVnaweR6x1KJU8CgnZiDMBKEwsiZw3gs-U8XnBIzbb8ImpdhYjoKnGv520oUKAA5RiAThamj1a0jGphmnDd3cCS6uIqdkSvxziE9ktL-MLNqbNFfgvdQuCo66YDqjhaHN7bqvliqaleUSRYZOd016M_N_ya21lamSxZcVintaktyvOApuAVgTMyIrrO8VuyhWW-cmiRFYKeTWnl2_kv9s_xQyWQ_PHH92rVCgRJwbofQEko4Isj4ZhLkA2xrurCPrz6VCtD5GYUfJNUWN_HcEHFsSqSYCsGfBAg"}}}},"components/schemas/AccessTokenWithPermittedActions":{"id":"components/schemas/AccessTokenWithPermittedActions","kind":"json-schema","title":"AccessTokenWithPermittedActions","data":{"type":"object","required":["result","permittedActions"],"properties":{"result":{"$ref":"#/components/schemas/AccessToken"},"permittedActions":{"type":"array","items":{"$ref":"#/components/schemas/PermittedAction"}}}}},"components/schemas/AssetShareEmailRequest":{"id":"components/schemas/AssetShareEmailRequest","kind":"json-schema","title":"AssetShareEmailRequest","data":{"type":"object","properties":{"assetShareId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID for the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Asset-Shares"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetShare"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to be emailed"},"children":[]}]}]}],"example":"4517a7ba-a482-4211-b97e-f4256f53fd32"},"email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The email address to send the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Asset-Shares"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetShare"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to"},"children":[]}]}]}],"example":"john.smith@gmail.com"}}}},"components/schemas/AssetShareSearchField":{"id":"components/schemas/AssetShareSearchField","kind":"json-schema","title":"AssetShareSearchField","data":{"type":"string","enum":["CREATED_BY"],"example":"CREATED_BY"}},"components/schemas/AssetShareFieldEqualsSearchCriterion":{"id":"components/schemas/AssetShareFieldEqualsSearchCriterion","kind":"json-schema","title":"AssetShareFieldEqualsSearchCriterion","data":{"allOf":[{"$ref":"#/components/schemas/FieldEqualsSearchCriterion"},{"type":"object","required":["type","field"],"properties":{"type":{"type":"string","enum":["FIELD_EQUALS"],"example":"FIELD_EQUALS"},"field":{"$ref":"#/components/schemas/AssetShareSearchField"}}}]}},"components/schemas/AssetShareSearchCriterion":{"id":"components/schemas/AssetShareSearchCriterion","kind":"json-schema","title":"AssetShareSearchCriterion","data":{"oneOf":[{"$ref":"#/components/schemas/AssetShareFieldEqualsSearchCriterion"}],"discriminator":{"propertyName":"type","mapping":{"FIELD_EQUALS":"#/components/schemas/AssetShareFieldEqualsSearchCriterion"}}}},"components/schemas/AssetShareSortField":{"id":"components/schemas/AssetShareSortField","kind":"json-schema","title":"AssetShareSortField","data":{"type":"string","enum":["ID","EXPIRY"],"example":"EXPIRY","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Asset-Shares"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetShare"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property value, the default is EXPIRY"},"children":[]}]}]}]}},"components/schemas/AssetShareSort":{"id":"components/schemas/AssetShareSort","kind":"json-schema","title":"AssetShareSort","data":{"type":"object","properties":{"field":{"$ref":"#/components/schemas/AssetShareSortField"},"order":{"$ref":"#/components/schemas/SortOrder"}}}},"components/schemas/AssetShareSearchRequest":{"id":"components/schemas/AssetShareSearchRequest","kind":"json-schema","title":"AssetShareSearchRequest","data":{"allOf":[{"$ref":"#/components/schemas/BasePaginatedSearchInAccountRequest"},{"type":"object","required":["criterion"],"properties":{"criterion":{"description":"The search criterion","$ref":"#/components/schemas/AssetShareSearchCriterion"},"sorts":{"description":"Sorts to be applied to the search in order of precedence","type":"array","items":{"$ref":"#/components/schemas/AssetShareSort"}}}}]}},"components/schemas/AssetShareSearch":{"id":"components/schemas/AssetShareSearch","kind":"json-schema","title":"AssetShareSearch","data":{"type":"object","required":["results","totalResults"],"properties":{"results":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The specified page of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Asset-Shares"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetShare"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources which match the search criterion"},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/AssetShareWithPermittedActions"}},"totalResults":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total number of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Asset-Shares"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetShare"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources which match the search criterion"},"children":[]}]}]}],"example":15}}}},"components/schemas/CommentPatchRequest":{"id":"components/schemas/CommentPatchRequest","kind":"json-schema","title":"CommentPatchRequest","data":{"type":"object","properties":{"text":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The text content of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Asset-Comments"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Comment"},"children":[]}]}]}]}],"example":"This is an edited comment that has been left by a user, how insightful!","maxLength":4000}}}},"components/schemas/Attribution":{"id":"components/schemas/Attribution","kind":"json-schema","title":"Attribution","data":{"type":"object","required":["source"],"properties":{"source":{"type":"string"},"freeText":{"type":"string","nullable":true}}}},"components/schemas/SelfReportedCompanyDescription":{"id":"components/schemas/SelfReportedCompanyDescription","kind":"json-schema","title":"SelfReportedCompanyDescription","data":{"type":"string","enum":["SELLING_PRODUCTS","CREATIVE_MARKETING_AGENCY","NON_PROFIT","OTHER","SKIPPED","NEVER_ASKED"],"example":"SELLING_PRODUCTS","default":"SKIPPED"}},"components/schemas/SelfReportedGoalFixed":{"id":"components/schemas/SelfReportedGoalFixed","kind":"json-schema","title":"SelfReportedGoalFixed","data":{"type":"object","required":["type","goal"],"properties":{"type":{"type":"string","enum":["FIXED"]},"goal":{"type":"string","enum":["ORGANISE_CREATIVE","SHARE_WITH_RETAILERS","SEND_TO_SHOPIFY","RESIZE_FOR_MARKETING_CHANNELS","COLLECT_AND_APPROVE"]}}}},"components/schemas/SelfReportedGoalOther":{"id":"components/schemas/SelfReportedGoalOther","kind":"json-schema","title":"SelfReportedGoalOther","data":{"type":"object","required":["type","goal"],"properties":{"type":{"type":"string","enum":["OTHER"]},"goal":{"type":"string","description":"A free text description of the goal"}}}},"components/schemas/SelfReportedGoal":{"id":"components/schemas/SelfReportedGoal","kind":"json-schema","title":"SelfReportedGoal","data":{"oneOf":[{"$ref":"#/components/schemas/SelfReportedGoalFixed"},{"$ref":"#/components/schemas/SelfReportedGoalOther"}],"discriminator":{"propertyName":"type","mapping":{"FIXED":"#/components/schemas/SelfReportedGoalFixed","OTHER":"#/components/schemas/SelfReportedGoalOther"}}}},"components/schemas/Beta":{"id":"components/schemas/Beta","kind":"json-schema","title":"Beta","data":{"type":"string","enum":["AI"],"example":"AI"}},"components/schemas/AccountRequest":{"id":"components/schemas/AccountRequest","kind":"json-schema","title":"AccountRequest","data":{"type":"object","required":["subdomain"],"properties":{"subdomain":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The subdomain of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Account"},"children":[]}]}]}],"type":"string","example":"planto"},"companyName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The company name of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", if not given this will default to the subdomain"},"children":[]}]}]}],"type":"string","example":"Planto"},"trialSignUpSource":{"type":"string","nullable":true},"attribution":{"type":"object","nullable":true,"allOf":[{"$ref":"#/components/schemas/Attribution"}]},"selfReportedCompanyDescription":{"$ref":"#/components/schemas/SelfReportedCompanyDescription"},"selfReportedGoals":{"type":"array","default":[],"items":{"$ref":"#/components/schemas/SelfReportedGoal"}},"referrerCode":{"type":"string","nullable":true},"optInToBetas":{"type":"array","default":[],"items":{"$ref":"#/components/schemas/Beta"}}}}},"components/schemas/AccountPlan":{"id":"components/schemas/AccountPlan","kind":"json-schema","title":"AccountPlan","data":{"type":"string","enum":["STAFF","STARTING","GROWING","DASHING","VALUE_BASED_FREE_TRIAL","VALUE_BASED_FREE_TRIAL_VERIFIED","VALUE_BASED_FREE_TRIAL_ENDED","VALUE_BASED_FREE_TRIAL_VERIFIED_ENDED","VALUE_BASED_UNVERIFIED","VALUE_BASED"]}},"components/schemas/Account":{"id":"components/schemas/Account","kind":"json-schema","title":"Account","data":{"type":"object","required":["id","subdomain","companyName","dateCreated","plan","selfReportedCompanyDescription","selfReportedGoals"],"properties":{"id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Account"},"children":[]}]}]}],"type":"string","example":"cfb665ca-ce35-4418-b9d5-70ee815db4bd"},"subdomain":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The subdomain "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Account"},"children":[]}]}]}],"type":"string","example":"planto"},"companyName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The company name of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", defaults to subdomain if not given in the request"},"children":[]}]}]}],"type":"string","example":"Planto"},"plan":{"$ref":"#/components/schemas/AccountPlan"},"dateCreated":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The datetime the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was created in ISO datetime format"},"children":[]}]}]}],"example":"2021-02-17T09:24:01.417Z"},"dateExpires":{"type":"string","nullable":true,"format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" expires if still in a free trial, in ISO date format"},"children":[]}]}]}],"example":"2021-02-27"},"trialSignUpSource":{"type":"string","nullable":true},"attribution":{"type":"object","nullable":true,"allOf":[{"$ref":"#/components/schemas/Attribution"}]},"selfReportedCompanyDescription":{"$ref":"#/components/schemas/SelfReportedCompanyDescription"},"selfReportedGoals":{"type":"array","items":{"$ref":"#/components/schemas/SelfReportedGoal"}}}}},"components/schemas/AccountWithPermittedActions":{"id":"components/schemas/AccountWithPermittedActions","kind":"json-schema","title":"AccountWithPermittedActions","data":{"type":"object","required":["result","permittedActions"],"properties":{"result":{"$ref":"#/components/schemas/Account"},"permittedActions":{"type":"array","items":{"$ref":"#/components/schemas/PermittedAction"}}}}},"components/schemas/AccountInviteRequest":{"id":"components/schemas/AccountInviteRequest","kind":"json-schema","title":"AccountInviteRequest","data":{"type":"object","required":["accountId"],"properties":{"accountId":{"description":"The ID of the account the invite request is for","type":"string","example":"cfb665ca-ce35-4418-b9d5-70ee815db4bd"}}}},"components/schemas/PubliclyAvailableAccountDataSearchField":{"id":"components/schemas/PubliclyAvailableAccountDataSearchField","kind":"json-schema","title":"PubliclyAvailableAccountDataSearchField","data":{"type":"string","enum":["SUBDOMAIN"],"example":"SUBDOMAIN","description":"The name of the search field"}},"components/schemas/PubliclyAvailableAccountDataFieldEqualsSearchCriterion":{"id":"components/schemas/PubliclyAvailableAccountDataFieldEqualsSearchCriterion","kind":"json-schema","title":"PubliclyAvailableAccountDataFieldEqualsSearchCriterion","data":{"allOf":[{"$ref":"#/components/schemas/FieldEqualsSearchCriterion"},{"type":"object","properties":{"type":{"type":"string","enum":["FIELD_EQUALS"]},"field":{"$ref":"#/components/schemas/PubliclyAvailableAccountDataSearchField"}}}]}},"components/schemas/PubliclyAvailableAccountDataHasUsersWithEmailDomainSearchCriterion":{"id":"components/schemas/PubliclyAvailableAccountDataHasUsersWithEmailDomainSearchCriterion","kind":"json-schema","title":"PubliclyAvailableAccountDataHasUsersWithEmailDomainSearchCriterion","data":{"allOf":[{"$ref":"#/components/schemas/SearchCriterion"},{"type":"object","required":["type","domain"],"properties":{"type":{"type":"string","enum":["HAS_USERS_WITH_EMAIL_DOMAIN"]},"domain":{"type":"string","description":"Check for users in the account with this email domain","example":"my-company.com"}}}]}},"components/schemas/PubliclyAvailableAccountDataSearchCriterion":{"id":"components/schemas/PubliclyAvailableAccountDataSearchCriterion","kind":"json-schema","title":"PubliclyAvailableAccountDataSearchCriterion","data":{"oneOf":[{"$ref":"#/components/schemas/PubliclyAvailableAccountDataFieldEqualsSearchCriterion"},{"$ref":"#/components/schemas/PubliclyAvailableAccountDataHasUsersWithEmailDomainSearchCriterion"}],"discriminator":{"propertyName":"type","mapping":{"FIELD_EQUALS":"#/components/schemas/PubliclyAvailableAccountDataFieldEqualsSearchCriterion","HAS_USERS_WITH_EMAIL_DOMAIN":"#/components/schemas/PubliclyAvailableAccountDataHasUsersWithEmailDomainSearchCriterion"}}}},"components/schemas/PubliclyAvailableAccountDataSearchRequest":{"id":"components/schemas/PubliclyAvailableAccountDataSearchRequest","kind":"json-schema","title":"PubliclyAvailableAccountDataSearchRequest","data":{"allOf":[{"$ref":"#/components/schemas/BasePaginatedSearchInAccountRequest"},{"type":"object","required":["criterion","sorts"],"properties":{"criterion":{"description":"The search criterion","$ref":"#/components/schemas/PubliclyAvailableAccountDataSearchCriterion"},"sorts":{"description":"This search does not accept any sorts, but has the sorts parameter anyway to fit in with other searches.  You must always provide an empty list for this parameter.","type":"array","items":{"type":"object"},"example":[]}}}]}},"components/schemas/LoginMethod":{"id":"components/schemas/LoginMethod","kind":"json-schema","title":"LoginMethod","data":{"type":"string","enum":["PASSWORD","GOOGLE","MICROSOFT"],"example":"PASSWORD"}},"components/schemas/PubliclyAvailableAccountData":{"id":"components/schemas/PubliclyAvailableAccountData","kind":"json-schema","title":"PubliclyAvailableAccountData","data":{"type":"object","required":["id","subdomain","allowedLoginMethods"],"properties":{"id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Account"},"children":[]}]}]}],"type":"string","example":"cfb665ca-ce35-4418-b9d5-70ee815db4bd"},"subdomain":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The subdomain "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Account"},"children":[]}]}]}],"type":"string","example":"planto"},"accentColour":{"type":"string","nullable":true,"description":"The hex code of the colour to be used to theme the account","example":"#333666"},"logoUrl":{"type":"string","nullable":true,"description":"The url of the logo for the account","example":"https://example.com"},"loginImageUrl":{"type":"string","nullable":true,"description":"The URL of the image to be displayed on the login screen","example":"https://example.com"},"faviconUrl":{"type":"string","nullable":true,"description":"The URL of the favicon for the account","example":"https://example.com"},"allowedLoginMethods":{"type":"array","description":"The allowed login methods for the account","items":{"$ref":"#/components/schemas/LoginMethod"}}}}},"components/schemas/PubliclyAvailableAccountDataWithPermittedActions":{"id":"components/schemas/PubliclyAvailableAccountDataWithPermittedActions","kind":"json-schema","title":"PubliclyAvailableAccountDataWithPermittedActions","data":{"type":"object","required":["result","permittedActions"],"properties":{"result":{"$ref":"#/components/schemas/PubliclyAvailableAccountData"},"permittedActions":{"type":"array","items":{"$ref":"#/components/schemas/PermittedAction"}}}}},"components/schemas/PubliclyAvailableAccountDataSearch":{"id":"components/schemas/PubliclyAvailableAccountDataSearch","kind":"json-schema","title":"PubliclyAvailableAccountDataSearch","data":{"type":"object","required":["results","totalResults"],"properties":{"results":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The specified page of ["},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PubliclyAvailableAccountData"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"] resources which match the search criterion"},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/PubliclyAvailableAccountDataWithPermittedActions"}},"totalResults":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total number of ["},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PubliclyAvailableAccountData"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"] resources which match the search criterion"},"children":[]}]}]}],"example":15}}}},"components/schemas/AccountSecurity":{"id":"components/schemas/AccountSecurity","kind":"json-schema","title":"AccountSecurity","data":{"type":"object","required":["accountId","mfaEnabled"],"properties":{"accountId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Account-Security"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AccountSecurity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is for"},"children":[]}]}]}],"type":"string","example":"cfb665ca-ce35-4418-b9d5-70ee815db4bd"},"mfaEnabled":{"type":"boolean","description":"Whether users of the account must configure and use multi-factor authentication on login\n","example":true}}}},"components/schemas/AccountSecurityWithPermittedActions":{"id":"components/schemas/AccountSecurityWithPermittedActions","kind":"json-schema","title":"AccountSecurityWithPermittedActions","data":{"type":"object","required":["result","permittedActions"],"properties":{"result":{"$ref":"#/components/schemas/AccountSecurity"},"permittedActions":{"type":"array","items":{"$ref":"#/components/schemas/PermittedAction"}}}}},"components/schemas/AccountSecurityPutRequest":{"id":"components/schemas/AccountSecurityPutRequest","kind":"json-schema","title":"AccountSecurityPutRequest","data":{"type":"object","required":["mfaEnabled"],"properties":{"mfaEnabled":{"type":"boolean","description":"Whether users of the account must configure and use multi-factor authentication on login\n","example":true}}}},"components/schemas/OriginalDownloadFilename":{"id":"components/schemas/OriginalDownloadFilename","kind":"json-schema","title":"OriginalDownloadFilename","data":{"type":"string","enum":["ASSET_TITLE","ORIGINAL_FILENAME"]}},"components/schemas/PresetSettings":{"id":"components/schemas/PresetSettings","kind":"json-schema","title":"PresetSettings","data":{"type":"object","required":["accountId","includeSocialMediaPresets","originalDownloadFilename"],"properties":{"accountId":{"description":"The ID of the account these preset settings belong to","type":"string","example":"cfb665ca-ce35-4418-b9d5-70ee815db4bd"},"includeSocialMediaPresets":{"description":"Whether social media presets are included for the account","type":"boolean","example":true},"originalDownloadFilename":{"$ref":"#/components/schemas/OriginalDownloadFilename","description":"Which filename to use when downloading an asset's original file"}}}},"components/schemas/PresetSettingsWithPermittedActions":{"id":"components/schemas/PresetSettingsWithPermittedActions","kind":"json-schema","title":"PresetSettingsWithPermittedActions","data":{"type":"object","required":["result","permittedActions"],"properties":{"result":{"$ref":"#/components/schemas/PresetSettings"},"permittedActions":{"type":"array","items":{"$ref":"#/components/schemas/PermittedAction"}}}}},"components/schemas/PresetSettingsPatchRequest":{"id":"components/schemas/PresetSettingsPatchRequest","kind":"json-schema","title":"PresetSettingsPatchRequest","data":{"type":"object","properties":{"includeSocialMediaPresets":{"description":"Whether social media presets are included for the account. Null or omitted values are ignored.","type":"boolean","nullable":true,"example":true},"originalDownloadFilename":{"description":"Which filename to use when downloading an asset's original file. Null or omitted values are ignored.","type":"string","nullable":true,"allOf":[{"$ref":"#/components/schemas/OriginalDownloadFilename"}]}}}},"components/schemas/BillingInfo":{"id":"components/schemas/BillingInfo","kind":"json-schema","title":"BillingInfo","data":{"type":"object","properties":{"scheduledSuspensionDate":{"type":"string","format":"date","nullable":true,"description":"The date the account is scheduled to be suspended, if one is scheduled.","example":"2026-06-10"}}}},"components/schemas/ReferenceImageAsset":{"id":"components/schemas/ReferenceImageAsset","kind":"json-schema","title":"ReferenceImageAsset","data":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string","description":"Image prompt asset id to feed into the AI image generator","example":"7af90a8b-7ccd-430f-a85d-e8614015bc47"}}}},"components/schemas/ReferenceImageUploaded":{"id":"components/schemas/ReferenceImageUploaded","kind":"json-schema","title":"ReferenceImageUploaded","data":{"type":"object","required":["type","key"],"properties":{"type":{"type":"string"},"key":{"type":"string","description":"Image prompt key for S3 bucket where image is held to feed into the AI image generator","example":"reference-image-uploads/cfb665ca-ce35-4418-b9d5-70ee815db4bd/3a26dafd-6f4d-4098-826d-ed258e789792"}}}},"components/schemas/ReferenceImage":{"id":"components/schemas/ReferenceImage","kind":"json-schema","title":"ReferenceImage","data":{"type":"object","nullable":true,"oneOf":[{"$ref":"#/components/schemas/ReferenceImageAsset"},{"$ref":"#/components/schemas/ReferenceImageUploaded"}],"discriminator":{"propertyName":"type","mapping":{"ASSET":"#/components/schemas/ReferenceImageAsset","UPLOADED":"#/components/schemas/ReferenceImageUploaded"}}}},"components/schemas/AiImageGenerationsRequest":{"id":"components/schemas/AiImageGenerationsRequest","kind":"json-schema","title":"AiImageGenerationsRequest","data":{"type":"object","required":["prompt"],"properties":{"prompt":{"type":"string","description":"Text prompt to feed into the AI image generator","example":"Oak table and chair set out in Wes Anderson style with green wall background and birch wood floor."},"referenceImage":{"$ref":"#/components/schemas/ReferenceImage"},"aspectRatio":{"type":"string","description":"Aspect ratio of the output image from the AI image generator","example":"1:1","enum":["3:7","9:16","10:16","2:3","3:4","4:5","1:1","5:4","4:3","3:2","16:10","16:9","7:3"],"default":"1:1"},"promptUpsampling":{"type":"boolean","example":false,"default":false},"seed":{"type":"integer","nullable":true,"example":null,"default":null},"safetyTolerance":{"type":"integer","example":2,"default":2},"outputFormat":{"type":"string","example":"png","enum":["png","jpeg"],"default":"png"},"numberOfImages":{"type":"integer","example":4,"default":4}}}},"components/schemas/AiImageGenerationsResponse":{"id":"components/schemas/AiImageGenerationsResponse","kind":"json-schema","title":"AiImageGenerationsResponse","data":{"type":"object","properties":{"result":{"type":"object","required":["imageUrls"],"properties":{"imageUrls":{"type":"array","description":"List of URLs linking to the response images","items":{"type":"string"},"example":["https://example.com/image1.png","https://example.com/image2.png","https://example.com/image3.png","https://example.com/image4.png"]}}},"permittedActions":{"type":"array","items":{"$ref":"#/components/schemas/PermittedAction"},"description":"Actions the user is allowed to perform"}}}},"components/schemas/ReferenceImageUploadsResponse":{"id":"components/schemas/ReferenceImageUploadsResponse","kind":"json-schema","title":"ReferenceImageUploadsResponse","data":{"type":"object","properties":{"result":{"type":"object","required":["key","url"],"properties":{"key":{"description":"The key that can be used to upload an image","type":"string","example":"3a26dafd-6f4d-4098-826d-ed258e789792"},"url":{"description":"The URL that can be used to upload an image","type":"string","example":"https://example.com"}}},"permittedActions":{"type":"array","items":{"$ref":"#/components/schemas/PermittedAction"},"description":"Actions the user is allowed to perform"}}}},"components/schemas/AutoTaggingImageSettings":{"id":"components/schemas/AutoTaggingImageSettings","kind":"json-schema","title":"AutoTaggingImageSettings","data":{"type":"object","required":["accountId","enabled","confidence"],"properties":{"accountId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Auto-Tagging-Image-Settings"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AutoTaggingImageSettings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is for"},"children":[]}]}]}],"type":"string","example":"cfb665ca-ce35-4418-b9d5-70ee815db4bd"},"enabled":{"type":"boolean","description":"Whether auto-tagging for images is enabled","example":true},"confidence":{"type":"number","description":"A number between 1 and 100 indicating how confident Dash should be about a tag being applicable to an image to include it\n","example":true}}}},"components/schemas/AutoTaggingImageSettingsWithPermittedActions":{"id":"components/schemas/AutoTaggingImageSettingsWithPermittedActions","kind":"json-schema","title":"AutoTaggingImageSettingsWithPermittedActions","data":{"type":"object","required":["result","permittedActions"],"properties":{"result":{"$ref":"#/components/schemas/AutoTaggingImageSettings"},"permittedActions":{"type":"array","items":{"$ref":"#/components/schemas/PermittedAction"}}}}},"components/schemas/AutoTaggingImageSettingsPatchRequest":{"id":"components/schemas/AutoTaggingImageSettingsPatchRequest","kind":"json-schema","title":"AutoTaggingImageSettingsPatchRequest","data":{"type":"object","properties":{"enabled":{"type":"boolean","nullable":true,"description":"Whether auto-tagging for images is enabled","example":true},"confidence":{"type":"number","nullable":true,"description":"A number between 1 and 100 indicating how confident Dash should be about a tag being applicable to an image to include it.\n","example":85}}}},"components/schemas/TextInImageSettings":{"id":"components/schemas/TextInImageSettings","kind":"json-schema","title":"TextInImageSettings","data":{"type":"object","required":["accountId","enabled","confidence"],"properties":{"accountId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Text-In-Image-Settings"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TextInImageSettings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is for"},"children":[]}]}]}],"type":"string","example":"cfb665ca-ce35-4418-b9d5-70ee815db4bd"},"enabled":{"type":"boolean","description":"Whether text in image extraction is enabled","example":true},"confidence":{"type":"number","description":"A number between 1 and 100 indicating how confident Dash should be about the text in the image\n","example":true}}}},"components/schemas/TextInImageSettingsWithPermittedActions":{"id":"components/schemas/TextInImageSettingsWithPermittedActions","kind":"json-schema","title":"TextInImageSettingsWithPermittedActions","data":{"type":"object","required":["result","permittedActions"],"properties":{"result":{"$ref":"#/components/schemas/TextInImageSettings"},"permittedActions":{"type":"array","items":{"$ref":"#/components/schemas/PermittedAction"}}}}},"components/schemas/TextInImageSettingsPatchRequest":{"id":"components/schemas/TextInImageSettingsPatchRequest","kind":"json-schema","title":"TextInImageSettingsPatchRequest","data":{"type":"object","properties":{"enabled":{"type":"boolean","nullable":true,"description":"Whether text in image extraction is enabled","example":true},"confidence":{"type":"number","nullable":true,"description":"A number between 1 and 100 indicating how confident Dash should be about the text in the image\n","example":85}}}},"components/schemas/OnboardingChecklist":{"id":"components/schemas/OnboardingChecklist","kind":"json-schema","title":"OnboardingChecklist","data":{"type":"object","required":["accountId","hasCompletedInitialImport","hasLoggedIn","hasUploadedSomeFiles","hasAddedSomeAttributes","hasSignedUp","hasCustomisedTheme","hasInvitedUsers"],"properties":{"accountId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Onboarding-Checklist"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OnboardingChecklist"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is for"},"children":[]}]}]}],"type":"string","example":"cfb665ca-ce35-4418-b9d5-70ee815db4bd"},"hasCompletedInitialImport":{"type":"boolean","example":true},"hasLoggedIn":{"type":"boolean","example":true},"hasUploadedSomeFiles":{"type":"boolean","example":true},"hasAddedSomeAttributes":{"type":"boolean","example":true},"hasSignedUp":{"type":"boolean","example":true},"hasCustomisedTheme":{"type":"boolean","example":true},"hasInvitedUsers":{"type":"boolean","example":true}}}},"components/schemas/OnboardingChecklistWithPermittedActions":{"id":"components/schemas/OnboardingChecklistWithPermittedActions","kind":"json-schema","title":"OnboardingChecklistWithPermittedActions","data":{"type":"object","required":["result","permittedActions"],"properties":{"result":{"$ref":"#/components/schemas/OnboardingChecklist"},"permittedActions":{"type":"array","items":{"$ref":"#/components/schemas/PermittedAction"}}}}},"components/schemas/OnboardingChecklistPatchRequest":{"id":"components/schemas/OnboardingChecklistPatchRequest","kind":"json-schema","title":"OnboardingChecklistPatchRequest","data":{"type":"object","properties":{"hasCompletedInitialImport":{"type":"boolean","nullable":true,"example":true},"hasLoggedIn":{"type":"boolean","nullable":true,"example":true},"hasUploadedSomeFiles":{"type":"boolean","nullable":true,"example":true},"hasAddedSomeAttributes":{"type":"boolean","nullable":true,"example":true},"hasSignedUp":{"type":"boolean","nullable":true,"example":true},"hasCustomisedTheme":{"type":"boolean","nullable":true,"example":true},"hasInvitedUsers":{"type":"boolean","nullable":true,"example":true}}}},"components/schemas/DynamicOnboardingChecklistItemId":{"id":"components/schemas/DynamicOnboardingChecklistItemId","kind":"json-schema","title":"DynamicOnboardingChecklistItemId","data":{"type":"string","description":"The identifier of a dynamic onboarding checklist item","enum":["CREATE_ACCOUNT","UPLOAD_SOME_FILES","CUSTOMISE_THEME","CONNECT_SHOPIFY_STORE","SET_UP_GUEST_UPLOAD","GET_VERIFIED","CREATE_PORTAL","INVITE_COLLEAGUE"],"example":"UPLOAD_SOME_FILES"}},"components/schemas/DynamicOnboardingChecklistItem":{"id":"components/schemas/DynamicOnboardingChecklistItem","kind":"json-schema","title":"DynamicOnboardingChecklistItem","data":{"type":"object","required":["id","completed"],"properties":{"id":{"$ref":"#/components/schemas/DynamicOnboardingChecklistItemId"},"completed":{"type":"boolean","example":false}}}},"components/schemas/DynamicOnboardingChecklist":{"id":"components/schemas/DynamicOnboardingChecklist","kind":"json-schema","title":"DynamicOnboardingChecklist","data":{"type":"object","required":["hasLoggedIn","hasSignedUp","isPanelDismissed","items"],"properties":{"hasLoggedIn":{"type":"boolean","example":true},"hasSignedUp":{"type":"boolean","example":true},"isPanelDismissed":{"type":"boolean","example":true},"items":{"type":"array","items":{"$ref":"#/components/schemas/DynamicOnboardingChecklistItem"}}}}},"components/schemas/DynamicOnboardingChecklistWithPermittedActions":{"id":"components/schemas/DynamicOnboardingChecklistWithPermittedActions","kind":"json-schema","title":"DynamicOnboardingChecklistWithPermittedActions","data":{"type":"object","required":["result","permittedActions"],"properties":{"result":{"$ref":"#/components/schemas/DynamicOnboardingChecklist"},"permittedActions":{"type":"array","items":{"$ref":"#/components/schemas/PermittedAction"}}}}},"components/schemas/DynamicOnboardingChecklistPatchRequest":{"id":"components/schemas/DynamicOnboardingChecklistPatchRequest","kind":"json-schema","title":"DynamicOnboardingChecklistPatchRequest","data":{"type":"object","properties":{"isPanelDismissed":{"type":"boolean","nullable":true,"description":"Whether the onboarding checklist has been dismissed","example":true}}}},"components/schemas/BaseSearchFilter":{"id":"components/schemas/BaseSearchFilter","kind":"json-schema","title":"BaseSearchFilter","data":{"type":"object","required":["id","accountId","adminOnly","allowEmpty"],"properties":{"id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Search-Filters"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SearchFilter"},"children":[]}]}]}]}],"type":"string","example":"502318d9-b42e-406c-b69d-f58dc15d8fa0"},"adminOnly":{"description":"Whether the filter is only visible to admin users","type":"boolean","example":true},"accountId":{"description":"The ID of the account the filter belongs to","type":"string","example":"cfb665ca-ce35-4418-b9d5-70ee815db4bd"},"allowEmpty":{"description":"Whether we can filter by an empty value","type":"boolean","example":true}}}},"components/schemas/FieldSearchFilter":{"id":"components/schemas/FieldSearchFilter","kind":"json-schema","title":"FieldSearchFilter","data":{"allOf":[{"$ref":"#/components/schemas/BaseSearchFilter"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["FIELD"]},"fieldId":{"description":"The ID of the field to filter by","type":"string","example":"a52b5315-15b8-417f-b742-d6902108bac1"}}}]}},"components/schemas/HardCodedFixedOptionsSearchFilter":{"id":"components/schemas/HardCodedFixedOptionsSearchFilter","kind":"json-schema","title":"HardCodedFixedOptionsSearchFilter","data":{"allOf":[{"$ref":"#/components/schemas/BaseSearchFilter"},{"type":"object","required":["type","searchField","name","options"],"properties":{"type":{"type":"string","enum":["HARD_CODED_FIXED_OPTION"]},"searchField":{"type":"string","description":[{"$$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":"AssetSearchField.fieldName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" which should be set when building search criteria for this filter when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetSearchField.type = 'FIXED'"},"children":[]}]}]}],"enum":["ORIENTATION","FILE_TYPE"]},"name":{"description":"The human readable name of the filter","type":"string","example":"File type"},"options":{"description":"A list of all the available options","type":"array","items":{"type":"string"},"example":["Image","Video","GIF","Audio","Document","Other"]}}}]}},"components/schemas/HardCodedFreeOptionsSearchFilter":{"id":"components/schemas/HardCodedFreeOptionsSearchFilter","kind":"json-schema","title":"HardCodedFreeOptionsSearchFilter","data":{"allOf":[{"$ref":"#/components/schemas/BaseSearchFilter"},{"type":"object","required":["type","searchField","name","dataType"],"properties":{"type":{"type":"string","enum":["HARD_CODED_FREE_OPTION"]},"searchField":{"type":"string","description":[{"$$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":"AssetSearchField.fieldName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" which should be set when building search criteria for this filter when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetSearchField.type = 'FIXED'"},"children":[]}]}]}],"enum":["DATE_LIVE"]},"name":{"description":"The human-readable name of the filter","type":"string","example":"Date Added"},"dataType":{"$ref":"#/components/schemas/DataType"}}}]}},"components/schemas/UserSearchField":{"id":"components/schemas/UserSearchField","kind":"json-schema","title":"UserSearchField","data":{"type":"string","enum":["IS_ADMIN","EMAIL","ID","TYPE","NAME"],"example":"IS_ADMIN","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Users"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource property value"},"children":[]}]}]}]}},"components/schemas/UserFieldEqualsSearchCriterion":{"id":"components/schemas/UserFieldEqualsSearchCriterion","kind":"json-schema","title":"UserFieldEqualsSearchCriterion","data":{"allOf":[{"$ref":"#/components/schemas/FieldEqualsSearchCriterion"},{"type":"object","required":["type","field"],"properties":{"type":{"type":"string","enum":["FIELD_EQUALS"]},"field":{"$ref":"#/components/schemas/UserSearchField"}}}]}},"components/schemas/UserFieldMatchesSearchCriterion":{"id":"components/schemas/UserFieldMatchesSearchCriterion","kind":"json-schema","title":"UserFieldMatchesSearchCriterion","data":{"allOf":[{"$ref":"#/components/schemas/FieldMatchesSearchCriterion"},{"type":"object","required":["type","field"],"properties":{"type":{"type":"string","enum":["FIELD_MATCHES"]},"field":{"$ref":"#/components/schemas/UserSearchField"}}}]}},"components/schemas/UserSearchCriterion":{"id":"components/schemas/UserSearchCriterion","kind":"json-schema","title":"UserSearchCriterion","data":{"oneOf":[{"$ref":"#/components/schemas/MatchAllSearchCriterion"},{"$ref":"#/components/schemas/UserFieldEqualsSearchCriterion"},{"$ref":"#/components/schemas/UserFieldMatchesSearchCriterion"},{"$ref":"#/components/schemas/UserOrSearchCriterion"},{"$ref":"#/components/schemas/UserAndSearchCriterion"},{"$ref":"#/components/schemas/UserNotSearchCriterion"},{"$ref":"#/components/schemas/UserInGroupWhereFieldEqualsSearchCriterion"},{"$ref":"#/components/schemas/UserCanUploadSearchCriterion"},{"$ref":"#/components/schemas/UserFieldInSearchCriterion"}],"discriminator":{"propertyName":"type","mapping":{"MATCH_ALL":"#/components/schemas/MatchAllSearchCriterion","FIELD_EQUALS":"#/components/schemas/UserFieldEqualsSearchCriterion","FIELD_MATCHES":"#/components/schemas/UserFieldMatchesSearchCriterion","OR":"#/components/schemas/UserOrSearchCriterion","AND":"#/components/schemas/UserAndSearchCriterion","NOT":"#/components/schemas/UserNotSearchCriterion","IN_GROUP_WHERE_FIELD_EQUALS":"#/components/schemas/UserInGroupWhereFieldEqualsSearchCriterion","CAN_UPLOAD":"#/components/schemas/UserCanUploadSearchCriterion","FIELD_IN":"#/components/schemas/UserFieldInSearchCriterion"}}}},"components/schemas/UserOrSearchCriterion":{"id":"components/schemas/UserOrSearchCriterion","kind":"json-schema","title":"UserOrSearchCriterion","data":{"allOf":[{"$ref":"#/components/schemas/SearchCriterion"},{"type":"object","required":["type","criteria"],"properties":{"type":{"type":"string","enum":["OR"]},"criteria":{"type":"array","description":"The list of criteria to OR together","items":{"$ref":"#/components/schemas/UserSearchCriterion"}}}}]}},"components/schemas/UserAndSearchCriterion":{"id":"components/schemas/UserAndSearchCriterion","kind":"json-schema","title":"UserAndSearchCriterion","data":{"allOf":[{"$ref":"#/components/schemas/SearchCriterion"},{"type":"object","required":["type","criteria"],"properties":{"type":{"type":"string","enum":["AND"]},"criteria":{"type":"array","description":"The list of criteria to AND together","items":{"$ref":"#/components/schemas/UserSearchCriterion"}}}}]}},"components/schemas/UserNotSearchCriterion":{"id":"components/schemas/UserNotSearchCriterion","kind":"json-schema","title":"UserNotSearchCriterion","data":{"allOf":[{"$ref":"#/components/schemas/SearchCriterion"},{"type":"object","required":["type","criterion"],"properties":{"type":{"type":"string","enum":["NOT"]},"criterion":{"$ref":"#/components/schemas/UserSearchCriterion"}}}]}},"components/schemas/UserGroupSearchField":{"id":"components/schemas/UserGroupSearchField","kind":"json-schema","title":"UserGroupSearchField","data":{"type":"string","enum":["ROLE"],"example":"ROLE","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UserGroup"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource property value"},"children":[]}]}]}]}},"components/schemas/UserInGroupWhereFieldEqualsSearchCriterion":{"id":"components/schemas/UserInGroupWhereFieldEqualsSearchCriterion","kind":"json-schema","title":"UserInGroupWhereFieldEqualsSearchCriterion","data":{"allOf":[{"$ref":"#/components/schemas/FieldEqualsSearchCriterion"},{"type":"object","required":["type","field"],"properties":{"type":{"type":"string","enum":["IN_GROUP_WHERE_FIELD_EQUALS"]},"field":{"$ref":"#/components/schemas/UserGroupSearchField"}}}]}},"components/schemas/UserCanUploadSearchCriterion":{"id":"components/schemas/UserCanUploadSearchCriterion","kind":"json-schema","title":"UserCanUploadSearchCriterion","data":{"allOf":[{"$ref":"#/components/schemas/SearchCriterion"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["CAN_UPLOAD"]}}}]}},"components/schemas/UserFieldInSearchCriterion":{"id":"components/schemas/UserFieldInSearchCriterion","kind":"json-schema","title":"UserFieldInSearchCriterion","data":{"allOf":[{"$ref":"#/components/schemas/FieldInSearchCriterion"},{"type":"object","required":["type","field"],"properties":{"type":{"type":"string","enum":["FIELD_IN"]},"field":{"$ref":"#/components/schemas/UserSearchField"}}}]}},"components/schemas/HardCodedUserSearchFilter":{"id":"components/schemas/HardCodedUserSearchFilter","kind":"json-schema","title":"HardCodedUserSearchFilter","data":{"allOf":[{"$ref":"#/components/schemas/BaseSearchFilter"},{"type":"object","required":["type","searchField","name","userSearchCriterion"],"properties":{"type":{"type":"string","enum":["HARD_CODED_USER"]},"searchField":{"type":"string","description":[{"$$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":"AssetSearchField.fieldName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" which should be set when building search criteria for this filter when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetSearchField.type = 'FIXED'"},"children":[]}]}]}],"enum":["STAGED_BY"]},"name":{"description":"The human-readable name of the filter","type":"string","example":"Date Added"},"userSearchCriterion":{"$ref":"#/components/schemas/UserSearchCriterion"}}}]}},"components/schemas/HardCodedFreeOptionDimensionsSearchFilter":{"id":"components/schemas/HardCodedFreeOptionDimensionsSearchFilter","kind":"json-schema","title":"HardCodedFreeOptionDimensionsSearchFilter","data":{"allOf":[{"$ref":"#/components/schemas/BaseSearchFilter"},{"type":"object","required":["type","name","searchFieldForWidth","searchFieldForHeight"],"properties":{"type":{"type":"string","enum":["HARD_CODED_FREE_OPTION_DIMENSION"]},"name":{"description":"The human-readable name of the filter","type":"string","example":"Dimension"},"searchFieldForWidth":{"type":"string","description":[{"$$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":"AssetSearchField.fieldName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to use for this filter."},"children":[]}]}]}],"enum":["WIDTH"]},"searchFieldForHeight":{"type":"string","description":[{"$$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":"AssetSearchField.fieldName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to use for this filter."},"children":[]}]}]}],"enum":["HEIGHT"]}}}]}},"components/schemas/SearchFilter":{"id":"components/schemas/SearchFilter","kind":"json-schema","title":"SearchFilter","data":{"oneOf":[{"$ref":"#/components/schemas/FieldSearchFilter"},{"$ref":"#/components/schemas/HardCodedFixedOptionsSearchFilter"},{"$ref":"#/components/schemas/HardCodedFreeOptionsSearchFilter"},{"$ref":"#/components/schemas/HardCodedUserSearchFilter"},{"$ref":"#/components/schemas/HardCodedFreeOptionDimensionsSearchFilter"}],"discriminator":{"propertyName":"type","mapping":{"FIELD":"#/components/schemas/FieldSearchFilter","HARD_CODED_FIXED_OPTION":"#/components/schemas/HardCodedFixedOptionsSearchFilter","HARD_CODED_FREE_OPTION":"#/components/schemas/HardCodedFreeOptionsSearchFilter","HARD_CODED_USER":"#/components/schemas/HardCodedUserSearchFilter","HARD_CODED_FREE_OPTION_DIMENSION":"#/components/schemas/HardCodedFreeOptionDimensionsSearchFilter"}}}},"components/schemas/SearchFilterWithPermittedActions":{"id":"components/schemas/SearchFilterWithPermittedActions","kind":"json-schema","title":"SearchFilterWithPermittedActions","data":{"type":"object","required":["result","permittedActions"],"properties":{"result":{"$ref":"#/components/schemas/SearchFilter"},"permittedActions":{"type":"array","items":{"$ref":"#/components/schemas/PermittedAction"}}}}},"components/schemas/SearchFilterView":{"id":"components/schemas/SearchFilterView","kind":"json-schema","title":"SearchFilterView","data":{"type":"object","required":["accountId","searchFilters"],"properties":{"accountId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the filter belongs to"},"children":[]}]}]}],"type":"string","example":"cfb665ca-ce35-4418-b9d5-70ee815db4bd"},"searchFilters":{"type":"array","items":{"$ref":"#/components/schemas/SearchFilter"}}}}},"components/schemas/SearchFilterViewWithPermittedActions":{"id":"components/schemas/SearchFilterViewWithPermittedActions","kind":"json-schema","title":"SearchFilterViewWithPermittedActions","data":{"type":"object","required":["result","permittedActions"],"properties":{"result":{"$ref":"#/components/schemas/SearchFilterView"},"permittedActions":{"type":"array","items":{"$ref":"#/components/schemas/PermittedAction"}}}}},"components/schemas/SearchFilterViewSearchFilterRequest":{"id":"components/schemas/SearchFilterViewSearchFilterRequest","kind":"json-schema","title":"SearchFilterViewSearchFilterRequest","data":{"type":"object","required":["searchFilterId","position"],"properties":{"searchFilterId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Search-Filters"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SearchFilter"},"children":[]}]}]}]}],"example":"4cb261ad-dffb-414e-89cf-6902e3031d44"},"position":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The zero-based display position of this "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Search-Filters"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SearchFilter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" within the search filter view"},"children":[]}]}]}],"example":0}}}},"components/schemas/SearchFilterViewSearchFilterPatchRequest":{"id":"components/schemas/SearchFilterViewSearchFilterPatchRequest","kind":"json-schema","title":"SearchFilterViewSearchFilterPatchRequest","data":{"type":"object","properties":{"position":{"type":"number","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The zero-based display position of this "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Search-Filters"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SearchFilter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" within the search filter view"},"children":[]}]}]}],"example":0}}}},"components/schemas/FolderSettings":{"id":"components/schemas/FolderSettings","kind":"json-schema","title":"FolderSettings","data":{"type":"object","required":["accountId","fieldId"],"properties":{"accountId":{"description":"The ID of the account the field belongs to","type":"string","example":"cfb665ca-ce35-4418-b9d5-70ee815db4bd"},"fieldId":{"description":"The ID of the field which represents folders for this account","type":"string","example":"7756d388-110c-4712-b350-0b2b48e156c1"}}}},"components/schemas/FolderSettingsWithPermittedActions":{"id":"components/schemas/FolderSettingsWithPermittedActions","kind":"json-schema","title":"FolderSettingsWithPermittedActions","data":{"type":"object","required":["result","permittedActions"],"properties":{"result":{"$ref":"#/components/schemas/FolderSettings"},"permittedActions":{"type":"array","items":{"$ref":"#/components/schemas/PermittedAction"}}}}},"components/schemas/ShopifySkuSettings":{"id":"components/schemas/ShopifySkuSettings","kind":"json-schema","title":"ShopifySkuSettings","data":{"type":"object","required":["fieldId"],"properties":{"fieldId":{"description":"The ID of the field which should be used to match SKUs in Shopify","type":"string","example":"7756d388-110c-4712-b350-0b2b48e156c1"}}}},"components/schemas/ShopifySkuSettingsWithPermittedActions":{"id":"components/schemas/ShopifySkuSettingsWithPermittedActions","kind":"json-schema","title":"ShopifySkuSettingsWithPermittedActions","data":{"type":"object","required":["result","permittedActions"],"properties":{"result":{"$ref":"#/components/schemas/ShopifySkuSettings"},"permittedActions":{"type":"array","items":{"$ref":"#/components/schemas/PermittedAction"}}}}},"components/schemas/ShopifySkuSettingsRequest":{"id":"components/schemas/ShopifySkuSettingsRequest","kind":"json-schema","title":"ShopifySkuSettingsRequest","data":{"type":"object","required":["fieldId"],"properties":{"fieldId":{"description":"The ID of the field which should be used to match SKUs in Shopify","type":"string","example":"7756d388-110c-4712-b350-0b2b48e156c1"}}}},"components/schemas/ShopifyInstallStatus":{"id":"components/schemas/ShopifyInstallStatus","kind":"json-schema","title":"ShopifyInstallStatus","data":{"type":"string","description":"The current status of the Shopify install","enum":["INSTALL_LINK_BEING_CREATED","READY_TO_INSTALL","INSTALLED"],"example":"READY_TO_INSTALL"}},"components/schemas/ShopifyInstall":{"id":"components/schemas/ShopifyInstall","kind":"json-schema","title":"ShopifyInstall","data":{"type":"object","description":"A derived view of the current Shopify install state for a Shopify domain.\n","required":["shopifyDomain","status"],"properties":{"shopifyDomain":{"description":"The Shopify domain that uniquely identifies the install","type":"string","example":"example.myshopify.com"},"status":{"$ref":"#/components/schemas/ShopifyInstallStatus"},"installLink":{"description":"The install link for the Shopify app","type":"string","nullable":true,"example":"https://admin.shopify.com/store/example/oauth/install_custom_app"}}}},"components/schemas/ShopifyInstallWithPermittedActions":{"id":"components/schemas/ShopifyInstallWithPermittedActions","kind":"json-schema","title":"ShopifyInstallWithPermittedActions","data":{"type":"object","required":["result","permittedActions"],"properties":{"result":{"$ref":"#/components/schemas/ShopifyInstall"},"permittedActions":{"type":"array","items":{"$ref":"#/components/schemas/PermittedAction"}}}}},"components/schemas/ShopifyInstallRequest":{"id":"components/schemas/ShopifyInstallRequest","kind":"json-schema","title":"ShopifyInstallRequest","data":{"type":"object","required":["shopifyDomain"],"properties":{"shopifyDomain":{"description":"The Shopify domain to request an install link for","type":"string","example":"example.myshopify.com"}}}},"components/schemas/ShopifyInstallPatchRequest":{"id":"components/schemas/ShopifyInstallPatchRequest","kind":"json-schema","title":"ShopifyInstallPatchRequest","data":{"type":"object","properties":{"installLink":{"description":"The install link for the Shopify app","type":"string","nullable":true,"example":"https://admin.shopify.com/store/example/oauth/install_custom_app"}}}},"components/schemas/Theme":{"id":"components/schemas/Theme","kind":"json-schema","title":"Theme","data":{"type":"object","required":["showRecentlyAddedAssets"],"properties":{"accentColour":{"type":"string","nullable":true,"description":"The hex code of the colour to be used to theme the account","example":"#333666"},"logoUrl":{"type":"string","nullable":true,"description":"The url of the logo for the account","example":"https://example.com"},"loginImageUrl":{"type":"string","nullable":true,"description":"The URL of the image to be displayed on the login screen","example":"https://example.com"},"faviconUrl":{"type":"string","nullable":true,"description":"The URL of the favicon for the account","example":"https://example.com"},"homepageImageUrl":{"type":"string","nullable":true,"description":"The URL of the image to be displayed on the homepage","example":"https://example.com"},"showRecentlyAddedAssets":{"type":"boolean","description":"Whether to include a preview of recently added assets on the homepage","example":true},"contextType":{"type":"string","enum":["PORTAL","ACCOUNT"],"description":"The type of context the theme applies in","example":"ACCOUNT"},"contextId":{"type":"string","description":"The identifier of the context the theme applies in","example":"cfb665ca-ce35-4418-b9d5-70ee815db4bd"}}}},"components/schemas/ThemeWithPermittedActions":{"id":"components/schemas/ThemeWithPermittedActions","kind":"json-schema","title":"ThemeWithPermittedActions","data":{"type":"object","required":["result","permittedActions"],"properties":{"result":{"$ref":"#/components/schemas/Theme"},"permittedActions":{"type":"array","items":{"$ref":"#/components/schemas/PermittedAction"}}}}},"components/schemas/NullableStringFieldPatch":{"id":"components/schemas/NullableStringFieldPatch","kind":"json-schema","title":"NullableStringFieldPatch","data":{"type":"object","properties":{"value":{"description":"The new value for the field","type":"string","nullable":true,"example":"example value"}}}},"components/schemas/ThemePatchRequest":{"id":"components/schemas/ThemePatchRequest","kind":"json-schema","title":"ThemePatchRequest","data":{"type":"object","properties":{"accentColour":{"$ref":"#/components/schemas/NullableStringFieldPatch","description":"The hex code of the colour to be used to theme the account","example":"#333666"},"showRecentlyAddedAssets":{"type":"boolean","nullable":true,"description":"Whether to include a preview of recently added assets on the homepage","example":true}}}},"components/schemas/KlaviyoInstallationStatus":{"id":"components/schemas/KlaviyoInstallationStatus","kind":"json-schema","title":"KlaviyoInstallationStatus","data":{"type":"string","description":"The installation state of Klaviyo for a Dash account.","enum":["INSTALLED","NOT_INSTALLED"]}},"components/schemas/KlaviyoInstallation":{"id":"components/schemas/KlaviyoInstallation","kind":"json-schema","title":"KlaviyoInstallation","data":{"type":"object","description":"The current Klaviyo installation state for a Dash account.","required":["status"],"properties":{"status":{"$ref":"#/components/schemas/KlaviyoInstallationStatus"}}}},"components/schemas/KlaviyoInstallationWithPermittedActions":{"id":"components/schemas/KlaviyoInstallationWithPermittedActions","kind":"json-schema","title":"KlaviyoInstallationWithPermittedActions","data":{"type":"object","required":["result","permittedActions"],"properties":{"result":{"$ref":"#/components/schemas/KlaviyoInstallation"},"permittedActions":{"type":"array","items":{"$ref":"#/components/schemas/PermittedAction"}}}}},"components/schemas/KlaviyoInstallationLink":{"id":"components/schemas/KlaviyoInstallationLink","kind":"json-schema","title":"KlaviyoInstallationLink","data":{"type":"object","description":"A one-time URL that begins the Klaviyo OAuth installation flow.","required":["authorizationUrl"],"properties":{"authorizationUrl":{"type":"string","format":"uri"}}}},"components/schemas/KlaviyoInstallationLinkWithPermittedActions":{"id":"components/schemas/KlaviyoInstallationLinkWithPermittedActions","kind":"json-schema","title":"KlaviyoInstallationLinkWithPermittedActions","data":{"type":"object","required":["result","permittedActions"],"properties":{"result":{"$ref":"#/components/schemas/KlaviyoInstallationLink"},"permittedActions":{"type":"array","items":{"$ref":"#/components/schemas/PermittedAction"}}}}},"components/schemas/KlaviyoExportAsset":{"id":"components/schemas/KlaviyoExportAsset","kind":"json-schema","title":"KlaviyoExportAsset","data":{"type":"object","required":["assetId","assetFileId"],"properties":{"assetId":{"type":"string","description":"The ID of the asset to export to Klaviyo.","example":"7af90a8b-7ccd-430f-a85d-e8614015bc47"},"assetFileId":{"type":"string","description":"The ID of the asset file to export to Klaviyo.","example":"7af90a8b-7ccd-430f-a85d-e8614015bc47"}}}},"components/schemas/KlaviyoExportJobRequest":{"id":"components/schemas/KlaviyoExportJobRequest","kind":"json-schema","title":"KlaviyoExportJobRequest","data":{"type":"object","required":["assets"],"properties":{"assets":{"type":"array","description":"The exact asset files to export to Klaviyo.","items":{"$ref":"#/components/schemas/KlaviyoExportAsset"}}}}},"components/schemas/KlaviyoExportResult":{"id":"components/schemas/KlaviyoExportResult","kind":"json-schema","title":"KlaviyoExportResult","data":{"type":"object","required":["totalAssets","successfulAssets","failedAssets"],"properties":{"totalAssets":{"type":"integer","description":"The total number of asset files selected for export.","example":3},"successfulAssets":{"type":"integer","description":"The number of asset files successfully exported to Klaviyo.","example":2},"failedAssets":{"type":"integer","description":"The number of asset files that could not be exported to Klaviyo.","example":1}}}},"components/schemas/KlaviyoExportCompletedJob":{"id":"components/schemas/KlaviyoExportCompletedJob","kind":"json-schema","title":"KlaviyoExportCompletedJob","data":{"allOf":[{"$ref":"#/components/schemas/CompletedJob"},{"type":"object","required":["result"],"properties":{"result":{"$ref":"#/components/schemas/KlaviyoExportResult"}}}]}},"components/schemas/KlaviyoExportJob":{"id":"components/schemas/KlaviyoExportJob","kind":"json-schema","title":"KlaviyoExportJob","data":{"oneOf":[{"$ref":"#/components/schemas/InProgressJob"},{"$ref":"#/components/schemas/KlaviyoExportCompletedJob"},{"$ref":"#/components/schemas/FailedJob"}],"discriminator":{"propertyName":"type","mapping":{"IN_PROGRESS":"#/components/schemas/InProgressJob","COMPLETED":"#/components/schemas/KlaviyoExportCompletedJob","FAILED":"#/components/schemas/FailedJob"}}}},"components/schemas/KlaviyoExportJobWithPermittedActions":{"id":"components/schemas/KlaviyoExportJobWithPermittedActions","kind":"json-schema","title":"KlaviyoExportJobWithPermittedActions","data":{"type":"object","required":["result","permittedActions"],"properties":{"result":{"$ref":"#/components/schemas/KlaviyoExportJob"},"permittedActions":{"type":"array","items":{"$ref":"#/components/schemas/PermittedAction"}}}}},"components/schemas/ThemeImageType":{"id":"components/schemas/ThemeImageType","kind":"json-schema","title":"ThemeImageType","data":{"type":"string","enum":["FAVICON","LOGO","HOMEPAGE_IMAGE","LOGIN_IMAGE"],"example":"FAVICON"}},"components/schemas/ThemeImageUploadRequest":{"id":"components/schemas/ThemeImageUploadRequest","kind":"json-schema","title":"ThemeImageUploadRequest","data":{"type":"object","required":["themeImageType"],"properties":{"themeImageType":{"$ref":"#/components/schemas/ThemeImageType","description":"The type of theme image to create an upload object for"}}}},"components/schemas/ThemeImageUpload":{"id":"components/schemas/ThemeImageUpload","kind":"json-schema","title":"ThemeImageUpload","data":{"type":"object","required":["url"],"properties":{"url":{"description":"The URL that can be used to upload an image","type":"string","example":"https://example.com"}}}},"components/schemas/ThemeSearchField":{"id":"components/schemas/ThemeSearchField","kind":"json-schema","title":"ThemeSearchField","data":{"type":"string","enum":["SUBDOMAIN","CONTEXT_TYPE","CONTEXT_ID"],"example":"SUBDOMAIN","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Theme"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Theme"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" search field"},"children":[]}]}]}]}},"components/schemas/ThemeFieldEqualsSearchCriterion":{"id":"components/schemas/ThemeFieldEqualsSearchCriterion","kind":"json-schema","title":"ThemeFieldEqualsSearchCriterion","data":{"allOf":[{"$ref":"#/components/schemas/FieldEqualsSearchCriterion"},{"type":"object","properties":{"field":{"$ref":"#/components/schemas/ThemeSearchField"}}}]}},"components/schemas/ThemeSearchCriterion":{"id":"components/schemas/ThemeSearchCriterion","kind":"json-schema","title":"ThemeSearchCriterion","data":{"oneOf":[{"$ref":"#/components/schemas/ThemeFieldEqualsSearchCriterion"},{"$ref":"#/components/schemas/ThemeAndSearchCriterion"}],"discriminator":{"propertyName":"type","mapping":{"FIELD_EQUALS":"#/components/schemas/ThemeFieldEqualsSearchCriterion","AND":"#/components/schemas/ThemeAndSearchCriterion"}}}},"components/schemas/ThemeAndSearchCriterion":{"id":"components/schemas/ThemeAndSearchCriterion","kind":"json-schema","title":"ThemeAndSearchCriterion","data":{"allOf":[{"$ref":"#/components/schemas/SearchCriterion"},{"type":"object","required":["type","criteria"],"properties":{"type":{"type":"string","enum":["AND"]},"criteria":{"type":"array","description":"The list of criteria to AND together","items":{"$ref":"#/components/schemas/ThemeSearchCriterion"}}}}]}},"components/schemas/ThemeSearchRequest":{"id":"components/schemas/ThemeSearchRequest","kind":"json-schema","title":"ThemeSearchRequest","data":{"allOf":[{"$ref":"#/components/schemas/BasePaginatedSearchInAccountRequest"},{"type":"object","required":["criterion","sorts"],"properties":{"criterion":{"description":"The search criterion","$ref":"#/components/schemas/ThemeSearchCriterion"},"sorts":{"description":"This search does not accept any sorts, but has the sorts parameter anyway to fit in with other searches.  You must always provide an empty list for this parameter.","type":"array","items":{"type":"object"},"example":[]}}}]}},"components/schemas/ThemeSearch":{"id":"components/schemas/ThemeSearch","kind":"json-schema","title":"ThemeSearch","data":{"type":"object","required":["results","totalResults"],"properties":{"results":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The specified page of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Theme"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Theme"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources which match the search criterion"},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/ThemeWithPermittedActions"}},"totalResults":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total number of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Theme"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Theme"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources which match the search criterion"},"children":[]}]}]}],"example":15}}}},"components/schemas/AdminUserRequest":{"id":"components/schemas/AdminUserRequest","kind":"json-schema","title":"AdminUserRequest","data":{"type":"object","required":["type","email"],"properties":{"type":{"type":"string","enum":["ADMIN"]},"email":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The email address of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Users"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]}]}]}]}],"type":"string","example":"john.smith@gmail.com"},"welcomeMessage":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An optional welcome message included in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Users"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" user invite email"},"children":[]}]}]}],"default":"You have been invited to join Dash — a tool for managing images, videos and more."}}}},"components/schemas/InGroupsUserRequest":{"id":"components/schemas/InGroupsUserRequest","kind":"json-schema","title":"InGroupsUserRequest","data":{"type":"object","required":["type","email","requiresUploadApproval","canApprove","canAddPortals","groupIds"],"properties":{"type":{"type":"string","enum":["IN_GROUPS"]},"email":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The email address of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Users"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]}]}]}]}],"type":"string","example":"john.smith@gmail.com"},"requiresUploadApproval":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Users"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'s uploads require approval"},"children":[]}]}]}],"type":"boolean","example":true},"canApprove":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Users"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can approve assets"},"children":[]}]}]}],"type":"boolean","example":true},"canAddPortals":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Users"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can create and manage portals they created"},"children":[]}]}]}],"type":"boolean","example":true},"groupIds":{"type":"array","description":"The IDs of the groups that this user should belong to","items":{"type":"string"}},"welcomeMessage":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An optional welcome message included in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Users"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" user invite email"},"children":[]}]}]}],"default":"You have been invited to join Dash — a tool for managing images, videos and more."}}}},"components/schemas/UserRequest":{"id":"components/schemas/UserRequest","kind":"json-schema","title":"UserRequest","data":{"oneOf":[{"$ref":"#/components/schemas/AdminUserRequest"},{"$ref":"#/components/schemas/InGroupsUserRequest"}],"discriminator":{"propertyName":"type","mapping":{"ADMIN":"#/components/schemas/AdminUserRequest","IN_GROUPS":"#/components/schemas/InGroupsUserRequest"}}}},"components/schemas/AccountUser":{"id":"components/schemas/AccountUser","kind":"json-schema","title":"AccountUser","data":{"oneOf":[{"$ref":"#/components/schemas/ActiveAccountUser"},{"$ref":"#/components/schemas/PendingAccountUser"}],"discriminator":{"propertyName":"type","mapping":{"ACTIVE_ACCOUNT_USER":"#/components/schemas/ActiveAccountUser","PENDING_ACCOUNT_USER":"#/components/schemas/PendingAccountUser"}}}},"components/schemas/AccountUserWithPermittedActions":{"id":"components/schemas/AccountUserWithPermittedActions","kind":"json-schema","title":"AccountUserWithPermittedActions","data":{"type":"object","required":["result","permittedActions"],"properties":{"result":{"$ref":"#/components/schemas/AccountUser"},"permittedActions":{"type":"array","items":{"$ref":"#/components/schemas/PermittedAction"}}}}},"components/schemas/UserWithNoPermittedActions":{"id":"components/schemas/UserWithNoPermittedActions","kind":"json-schema","title":"UserWithNoPermittedActions","data":{"type":"object","required":["result","permittedActions"],"properties":{"result":{"$ref":"#/components/schemas/User"},"permittedActions":{"type":"array","items":{"$ref":"#/components/schemas/PermittedAction"}}}}},"components/schemas/AdminUserPatchRequest":{"id":"components/schemas/AdminUserPatchRequest","kind":"json-schema","title":"AdminUserPatchRequest","data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["ADMIN"]}}}},"components/schemas/InGroupsUserPatchRequest":{"id":"components/schemas/InGroupsUserPatchRequest","kind":"json-schema","title":"InGroupsUserPatchRequest","data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["IN_GROUPS"]},"requiresUploadApproval":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Users"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'s uploads require approval"},"children":[]}]}]}],"type":"boolean","nullable":true,"example":true},"canApprove":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Users"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can approve assets"},"children":[]}]}]}],"type":"boolean","nullable":true,"example":true},"canAddPortals":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Users"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can create and manage portals they created"},"children":[]}]}]}],"type":"boolean","nullable":true,"example":true},"groupIds":{"type":"array","description":"The IDs of the groups that this user should belong to","nullable":true,"items":{"type":"string"}}}}},"components/schemas/UserPatchRequest":{"id":"components/schemas/UserPatchRequest","kind":"json-schema","title":"UserPatchRequest","data":{"oneOf":[{"$ref":"#/components/schemas/AdminUserPatchRequest"},{"$ref":"#/components/schemas/InGroupsUserPatchRequest"}],"discriminator":{"propertyName":"type","mapping":{"ADMIN":"#/components/schemas/AdminUserPatchRequest","IN_GROUPS":"#/components/schemas/InGroupsUserPatchRequest"}}}},"components/schemas/AdminUserRequestItem":{"id":"components/schemas/AdminUserRequestItem","kind":"json-schema","title":"AdminUserRequestItem","data":{"allOf":[{"$ref":"#/components/schemas/BatchItem"},{"$ref":"#/components/schemas/AdminUserRequest"}]}},"components/schemas/InGroupsUserRequestItem":{"id":"components/schemas/InGroupsUserRequestItem","kind":"json-schema","title":"InGroupsUserRequestItem","data":{"allOf":[{"$ref":"#/components/schemas/BatchItem"},{"$ref":"#/components/schemas/InGroupsUserRequest"}]}},"components/schemas/UserBatchRequestItem":{"id":"components/schemas/UserBatchRequestItem","kind":"json-schema","title":"UserBatchRequestItem","data":{"oneOf":[{"$ref":"#/components/schemas/AdminUserRequestItem"},{"$ref":"#/components/schemas/InGroupsUserRequestItem"}],"discriminator":{"propertyName":"type","mapping":{"ADMIN":"#/components/schemas/AdminUserRequestItem","IN_GROUPS":"#/components/schemas/InGroupsUserRequestItem"}}}},"components/schemas/UserBatchRequest":{"id":"components/schemas/UserBatchRequest","kind":"json-schema","title":"UserBatchRequest","data":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/UserBatchRequestItem"}}}}},"components/schemas/UserFailure":{"id":"components/schemas/UserFailure","kind":"json-schema","title":"UserFailure","data":{"type":"string","enum":["USER_ALREADY_EXISTS","UNEXPECTED_ERROR"]}},"components/schemas/UserBatch":{"id":"components/schemas/UserBatch","kind":"json-schema","title":"UserBatch","data":{"type":"object","required":["successes","failures"],"properties":{"successes":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A map of new account users keyed on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"batchItemId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" provided in the request"},"children":[]}]}]}],"additionalProperties":{"$ref":"#/components/schemas/AccountUserWithPermittedActions"}},"failures":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A map of failures keyed on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"batchItemId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" provided in the request"},"children":[]}]}]}],"additionalProperties":{"$ref":"#/components/schemas/UserFailure"}}}}},"components/schemas/UserBatchCompletedJob":{"id":"components/schemas/UserBatchCompletedJob","kind":"json-schema","title":"UserBatchCompletedJob","data":{"allOf":[{"$ref":"#/components/schemas/CompletedJob"},{"type":"object","required":["result"],"properties":{"result":{"$ref":"#/components/schemas/UserBatch"}}}]}},"components/schemas/UserBatchJob":{"id":"components/schemas/UserBatchJob","kind":"json-schema","title":"UserBatchJob","data":{"oneOf":[{"$ref":"#/components/schemas/InProgressJob"},{"$ref":"#/components/schemas/UserBatchCompletedJob"},{"$ref":"#/components/schemas/FailedJob"}],"discriminator":{"propertyName":"type","mapping":{"IN_PROGRESS":"#/components/schemas/InProgressJob","COMPLETED":"#/components/schemas/UserBatchCompletedJob","FAILED":"#/components/schemas/FailedJob"}}}},"components/schemas/UserSortField":{"id":"components/schemas/UserSortField","kind":"json-schema","title":"UserSortField","data":{"type":"string","enum":["EMAIL"],"example":"EMAIL","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Users"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property value to sort buy"},"children":[]}]}]}]}},"components/schemas/UserSort":{"id":"components/schemas/UserSort","kind":"json-schema","title":"UserSort","data":{"type":"object","required":["field","order"],"properties":{"field":{"$ref":"#/components/schemas/UserSortField"},"order":{"$ref":"#/components/schemas/SortOrder"}}}},"components/schemas/UserSearchRequest":{"id":"components/schemas/UserSearchRequest","kind":"json-schema","title":"UserSearchRequest","data":{"allOf":[{"$ref":"#/components/schemas/BasePaginatedSearchInAccountRequest"},{"type":"object","required":["criterion","sorts"],"properties":{"criterion":{"description":"The search criterion","$ref":"#/components/schemas/UserSearchCriterion"},"sorts":{"description":"Sorts to be applied to the search in order of precedence","type":"array","items":{"$ref":"#/components/schemas/UserSort"}}}}]}},"components/schemas/UserSearch":{"id":"components/schemas/UserSearch","kind":"json-schema","title":"UserSearch","data":{"type":"object","required":["results","totalResults"],"properties":{"results":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The specified page of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Users"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources  which match the search criterion"},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/UserWithNoPermittedActions"}},"totalResults":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total number of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Users"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources which match the search criterion"},"children":[]}]}]}],"example":10}}}},"components/schemas/UserDeleteRequest":{"id":"components/schemas/UserDeleteRequest","kind":"json-schema","title":"UserDeleteRequest","data":{"type":"object","properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Users"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or the User's email"},"children":[]}]}]}],"example":"cfb665ca-ce35-4418-b9d5-70ee815db4bd"},"deleteAssetShares":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to delete all "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Asset-Shares"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetShares"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" belonging to the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Users"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]}]}]}]}],"example":true}}}},"components/schemas/UnverifiedFreeTrialDenialReason":{"id":"components/schemas/UnverifiedFreeTrialDenialReason","kind":"json-schema","title":"UnverifiedFreeTrialDenialReason","data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["UNVERIFIED_FREE_TRIAL"]}}}},"components/schemas/UnverifiedPaidPlanDenialReason":{"id":"components/schemas/UnverifiedPaidPlanDenialReason","kind":"json-schema","title":"UnverifiedPaidPlanDenialReason","data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["UNVERIFIED_PAID_PLAN"]}}}},"components/schemas/PlanUpgradeRequiredDenialReason":{"id":"components/schemas/PlanUpgradeRequiredDenialReason","kind":"json-schema","title":"PlanUpgradeRequiredDenialReason","data":{"type":"object","required":["type","acceptablePlans"],"properties":{"type":{"type":"string","enum":["PLAN_UPGRADE_REQUIRED"]},"acceptablePlans":{"type":"array","description":"The plans that the account could be upgraded to in order to get access to this action.","items":{"$ref":"#/components/schemas/AccountPlan"}}}}},"components/schemas/DenialReason":{"id":"components/schemas/DenialReason","kind":"json-schema","title":"DenialReason","data":{"description":"The reason that this action is denied.","oneOf":[{"$ref":"#/components/schemas/UnverifiedFreeTrialDenialReason"},{"$ref":"#/components/schemas/UnverifiedPaidPlanDenialReason"},{"$ref":"#/components/schemas/PlanUpgradeRequiredDenialReason"}],"discriminator":{"propertyName":"type","mapping":{"UNVERIFIED_FREE_TRIAL":"#/components/schemas/UnverifiedFreeTrialDenialReason","UNVERIFIED_PAID_PLAN":"#/components/schemas/UnverifiedPaidPlanDenialReason","PLAN_UPGRADE_REQUIRED":"#/components/schemas/PlanUpgradeRequiredDenialReason"}}}},"components/schemas/DeniedActionWithReason":{"id":"components/schemas/DeniedActionWithReason","kind":"json-schema","title":"DeniedActionWithReason","data":{"type":"object","required":["resourceType","action"],"properties":{"resourceType":{"$ref":"#/components/schemas/ResourceType"},"resourceId":{"type":"string","nullable":true,"description":"The ID of the resource on which this action is being denied.  This may be null if the permission is on the resource type as a whole rather than an individual instance.","example":"7af90a8b-7ccd-430f-a85d-e8614015bc47"},"action":{"$ref":"#/components/schemas/ActionType"},"denialReason":{"$ref":"#/components/schemas/DenialReason"}}}},"components/schemas/UserWithPermittedActions":{"id":"components/schemas/UserWithPermittedActions","kind":"json-schema","title":"UserWithPermittedActions","data":{"type":"object","required":["result","permittedActions"],"properties":{"result":{"$ref":"#/components/schemas/User"},"permittedActions":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permitted actions which are not associated with a specific API resource instance are included here."},"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":"ASSETS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" : "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CREATE_ASSETS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Whether the user can create new assets"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ASSETS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" : "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PUT_ASSETS_IN_NO_FOLDER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Whether the user can create / edit an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources such that they have no value for the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Folder-Settings"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Folder Field"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ASSETS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" : "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SET_ASSETS_STAGING_STATUS_LIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Whether the user can set "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset.lifecycleStatus.state"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" via the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Asset-Lifecycle"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Asset Lifecycle"},"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":"text","inline":true,"attributes":{"content":" : "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EDIT_FIELDS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Whether the user can create, edit and delete "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources"},"children":[]}]}]}]}],"items":{"$ref":"#/components/schemas/PermittedAction"}},"deniedActionsWithReasons":{"type":"array","description":"Actions that are denied due to the user's account plan, along with the reason for denial.\n","items":{"$ref":"#/components/schemas/DeniedActionWithReason"}}}}},"components/schemas/Referrer":{"id":"components/schemas/Referrer","kind":"json-schema","title":"Referrer","data":{"type":"object","required":["code"],"properties":{"code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The code for this ["},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Referrer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"]"},"children":[]}]}]}],"example":"5fb665ca-ce35-4418-b9d5-70ee815db4bd"}}}},"components/schemas/ReferrerWithPermittedActions":{"id":"components/schemas/ReferrerWithPermittedActions","kind":"json-schema","title":"ReferrerWithPermittedActions","data":{"type":"object","required":["result","permittedActions"],"properties":{"result":{"$ref":"#/components/schemas/Referrer"},"permittedActions":{"type":"array","items":{"$ref":"#/components/schemas/PermittedAction"}}}}},"components/schemas/MatchValues":{"id":"components/schemas/MatchValues","kind":"json-schema","title":"MatchValues","data":{"type":"string","enum":["ALL","ANY"]}},"components/schemas/UserPreferences":{"id":"components/schemas/UserPreferences","kind":"json-schema","title":"UserPreferences","data":{"type":"object","required":["userId","defaultSort","defaultSearchFiltersMatchValues"],"properties":{"userId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Users"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" whose preferences these are"},"children":[]}]}]}],"example":"google-oauth2|110955770826801837334"},"defaultSort":{"type":"object","nullable":true,"allOf":[{"$ref":"#/components/schemas/AssetSort"}]},"defaultSearchFiltersMatchValues":{"type":"object","description":"A map keyed on filter id, of the initial match values operation (ALL/ANY) for the user's search filters.","additionalProperties":{"$ref":"#/components/schemas/MatchValues"}}}}},"components/schemas/UserPreferencesWithPermittedActions":{"id":"components/schemas/UserPreferencesWithPermittedActions","kind":"json-schema","title":"UserPreferencesWithPermittedActions","data":{"type":"object","required":["result","permittedActions"],"properties":{"result":{"$ref":"#/components/schemas/UserPreferences"},"permittedActions":{"type":"array","items":{"$ref":"#/components/schemas/PermittedAction"}}}}},"components/schemas/NullableAssetSortFieldPatch":{"id":"components/schemas/NullableAssetSortFieldPatch","kind":"json-schema","title":"NullableAssetSortFieldPatch","data":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/AssetSort"}}}},"components/schemas/UserPreferencesPatchRequest":{"id":"components/schemas/UserPreferencesPatchRequest","kind":"json-schema","title":"UserPreferencesPatchRequest","data":{"type":"object","properties":{"defaultSort":{"type":"object","nullable":true,"allOf":[{"$ref":"#/components/schemas/NullableAssetSortFieldPatch"}]},"defaultSearchFiltersMatchValues":{"nullable":true,"type":"object","additionalProperties":{"$ref":"#/components/schemas/MatchValues"}}}}},"components/schemas/UserCreationStatusResponse":{"id":"components/schemas/UserCreationStatusResponse","kind":"json-schema","title":"UserCreationStatusResponse","data":{"type":"object","required":["status"],"properties":{"status":{"type":"string","description":"Either PENDING or CREATED depending on the current status","enum":["PENDING","CREATED"]}}}},"components/schemas/UserCreationStatusResponseWithPermittedActions":{"id":"components/schemas/UserCreationStatusResponseWithPermittedActions","kind":"json-schema","title":"UserCreationStatusResponseWithPermittedActions","data":{"type":"object","required":["result","permittedActions"],"properties":{"result":{"$ref":"#/components/schemas/UserCreationStatusResponse"},"permittedActions":{"type":"array","items":{"$ref":"#/components/schemas/PermittedAction"}}}}},"components/schemas/GroupWithPermittedActions":{"id":"components/schemas/GroupWithPermittedActions","kind":"json-schema","title":"GroupWithPermittedActions","data":{"type":"object","required":["result","permittedActions"],"properties":{"result":{"$ref":"#/components/schemas/Group"},"permittedActions":{"type":"array","items":{"$ref":"#/components/schemas/PermittedAction"}}}}},"components/schemas/GroupsWithPermittedActions":{"id":"components/schemas/GroupsWithPermittedActions","kind":"json-schema","title":"GroupsWithPermittedActions","data":{"type":"array","items":{"$ref":"#/components/schemas/GroupWithPermittedActions"}}},"components/schemas/GroupRequest":{"id":"components/schemas/GroupRequest","kind":"json-schema","title":"GroupRequest","data":{"type":"object","required":["name","role","fieldWhitelist"],"properties":{"name":{"description":"The name of the group","type":"string"},"role":{"$ref":"#/components/schemas/GroupRole"},"fieldWhitelist":{"$ref":"#/components/schemas/FieldWhitelist"}}}},"components/schemas/GroupPatchRequest":{"id":"components/schemas/GroupPatchRequest","kind":"json-schema","title":"GroupPatchRequest","data":{"type":"object","properties":{"name":{"description":"The name of the group","nullable":true,"type":"string"},"role":{"nullable":true,"type":"object","allOf":[{"$ref":"#/components/schemas/GroupRole"}]},"fieldWhitelist":{"nullable":true,"type":"object","allOf":[{"$ref":"#/components/schemas/FieldWhitelist"}]}}}},"components/schemas/StaffMember":{"id":"components/schemas/StaffMember","kind":"json-schema","title":"StaffMember","data":{"type":"object","required":["id","email"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Staff-Members"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"StaffMember"},"children":[]}]}]}]}],"example":"55f9964c-095d-4b8b-bb5e-4118d2e76ad0"},"email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Email of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Staff-Members"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"StaffMember"},"children":[]}]}]}]}],"example":"some-staff-name@dash.app"}}}},"components/schemas/StaffMemberRequest":{"id":"components/schemas/StaffMemberRequest","kind":"json-schema","title":"StaffMemberRequest","data":{"type":"object","required":["email"],"properties":{"email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Email of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Staff-Members"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"StaffMember"},"children":[]}]}]}]}],"example":"some-staff-name@dash.app"}}}},"components/schemas/CollectionRequest":{"id":"components/schemas/CollectionRequest","kind":"json-schema","title":"CollectionRequest","data":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Collections"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Collection"},"children":[]}]}]}]}],"example":"Folders"}}}},"components/schemas/CollectionCollaborator":{"id":"components/schemas/CollectionCollaborator","kind":"json-schema","title":"CollectionCollaborator","data":{"type":"object","required":["id","collectionId","userId"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CollectionCollaborator"},"children":[]}]}]}],"example":"76c5765e-4623-41c9-a521-23610343f019"},"collectionId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Collections"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Collection"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" which is being collaborated on"},"children":[]}]}]}],"type":"string","example":"a52b5315-15b8-417f-b742-d6902108bac1"},"userId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Users"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" who is a collaborator"},"children":[]}]}]}],"example":"google-oauth2|110955770826801837334"}}}},"components/schemas/CollectionShare":{"id":"components/schemas/CollectionShare","kind":"json-schema","title":"CollectionShare","data":{"type":"object","required":["id","accountId","collectionId","collectionName","currentSlug","slugs","expiry","assetPermittedActions"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID for the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Collection-Shares"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CollectionShare"},"children":[]}]}]}]}],"example":"4517a7ba-a482-4211-b97e-f4256f53fd32"},"accountId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Collection-Shares"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CollectionShare"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" belongs to"},"children":[]}]}]}],"type":"string","example":"cfb665ca-ce35-4418-b9d5-70ee815db4bd"},"collectionId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Collections"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Collection"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" which is being shared"},"children":[]}]}]}],"type":"string","example":"a52b5315-15b8-417f-b742-d6902108bac1"},"collectionName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Collections"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Collection"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" which is being shared"},"children":[]}]}]}],"example":"Folders"},"currentSlug":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A human readable unique identifier based on the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Collections"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Collection"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name, used in the Dash frontend share URL"},"children":[]}]}]}],"example":"EW7DT/folders"},"slugs":{"description":"The set of all slugs that have ever been used, maintained so that old share URLs still work","type":"array","items":{"type":"string"},"example":["EW7DT/folders","B35FP/old-name"]},"expiry":{"type":"string","nullable":true,"format":"date-time","description":"The datetime the share will expire and no longer be accessible in ISO datetime format. If the expiry is null, the share will never expire.","example":"2021-02-17T09:24:01.417Z"},"assetPermittedActions":{"$ref":"#/components/schemas/AssetPermittedActions"}}}},"components/schemas/Collection":{"id":"components/schemas/Collection","kind":"json-schema","title":"Collection","data":{"type":"object","required":["id","accountId","name","creatorId","dateCreated","collaborators"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Collections"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Collection"},"children":[]}]}]}]}],"example":"a52b5315-15b8-417f-b742-d6902108bac1"},"accountId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Collections"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Collection"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" belongs to"},"children":[]}]}]}],"type":"string","example":"cfb665ca-ce35-4418-b9d5-70ee815db4bd"},"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Collections"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Collection"},"children":[]}]}]}]}],"example":"Folders"},"creatorId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Users"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" who created the collection"},"children":[]}]}]}],"type":"string","example":"google-oauth2|110955770826801837334"},"dateCreated":{"type":"string","format":"date-time","description":"The datetime the collection was created in ISO datetime format","example":"2021-02-17T09:24:01.417Z"},"collaborators":{"type":"array","items":{"$ref":"#/components/schemas/CollectionCollaborator"}},"share":{"$ref":"#/components/schemas/CollectionShare"}}}},"components/schemas/CollectionWithPermittedActions":{"id":"components/schemas/CollectionWithPermittedActions","kind":"json-schema","title":"CollectionWithPermittedActions","data":{"type":"object","required":["result","permittedActions"],"properties":{"result":{"$ref":"#/components/schemas/Collection"},"permittedActions":{"type":"array","items":{"$ref":"#/components/schemas/PermittedAction"}}}}},"components/schemas/CollectionPatchRequest":{"id":"components/schemas/CollectionPatchRequest","kind":"json-schema","title":"CollectionPatchRequest","data":{"type":"object","properties":{"name":{"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":"Name of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Collections"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Collection"},"children":[]}]}]}]}],"example":"Folders"}}}},"components/schemas/CollectionAssociatedWithUserSearchCriterion":{"id":"components/schemas/CollectionAssociatedWithUserSearchCriterion","kind":"json-schema","title":"CollectionAssociatedWithUserSearchCriterion","data":{"allOf":[{"$ref":"#/components/schemas/SearchCriterion"},{"type":"object","properties":{"userId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Users"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" who either created or is a collaborator on the collection"},"children":[]}]}]}],"type":"string","example":"google-oauth2|110955770826801837334"}}}]}},"components/schemas/CollectionSearchCriterion":{"id":"components/schemas/CollectionSearchCriterion","kind":"json-schema","title":"CollectionSearchCriterion","data":{"oneOf":[{"$ref":"#/components/schemas/CollectionAssociatedWithUserSearchCriterion"}],"discriminator":{"propertyName":"type","mapping":{"ASSOCIATED_WITH_USER":"#/components/schemas/CollectionAssociatedWithUserSearchCriterion"}}}},"components/schemas/CollectionSortField":{"id":"components/schemas/CollectionSortField","kind":"json-schema","title":"CollectionSortField","data":{"type":"string","enum":["NAME"],"example":"NAME","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Collections"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Collection"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property value"},"children":[]}]}]}]}},"components/schemas/CollectionSort":{"id":"components/schemas/CollectionSort","kind":"json-schema","title":"CollectionSort","data":{"type":"object","properties":{"field":{"$ref":"#/components/schemas/CollectionSortField"},"order":{"$ref":"#/components/schemas/SortOrder"}}}},"components/schemas/CollectionSearchRequest":{"id":"components/schemas/CollectionSearchRequest","kind":"json-schema","title":"CollectionSearchRequest","data":{"allOf":[{"$ref":"#/components/schemas/BasePaginatedSearchInAccountRequest"},{"type":"object","properties":{"criterion":{"description":"The search criterion","$ref":"#/components/schemas/CollectionSearchCriterion"},"sorts":{"description":"Sorts to be applied to the search in order of precedence","type":"array","items":{"$ref":"#/components/schemas/CollectionSort"}}}}]}},"components/schemas/CollectionSearch":{"id":"components/schemas/CollectionSearch","kind":"json-schema","title":"CollectionSearch","data":{"type":"object","properties":{"results":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The specified page of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Collections"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Collection"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources which match the search criterion"},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/CollectionWithPermittedActions"}},"totalResults":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total number of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Collections"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Collection"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources which match the search criterion"},"children":[]}]}]}],"example":15}}}},"components/schemas/SubdomainAvailabilityCheckRequest":{"id":"components/schemas/SubdomainAvailabilityCheckRequest","kind":"json-schema","title":"SubdomainAvailabilityCheckRequest","data":{"type":"object","properties":{"subdomain":{"description":"The subdomain to check for availability","type":"string","example":"my-company"}}}},"components/schemas/SubdomainAvailabilityCheck":{"id":"components/schemas/SubdomainAvailabilityCheck","kind":"json-schema","title":"SubdomainAvailabilityCheck","data":{"type":"object","properties":{"subdomain":{"description":"The subdomain that was checked for availability","type":"string","example":"my-company"},"isAvailable":{"type":"boolean","example":true}}}},"components/schemas/ResizeTransformationTemplate":{"id":"components/schemas/ResizeTransformationTemplate","kind":"json-schema","title":"ResizeTransformationTemplate","data":{"type":"object","required":["type","width","height"],"properties":{"type":{"type":"string","enum":["RESIZE"]},"width":{"type":"integer","description":"The maximum width the resized file should have","example":400},"height":{"type":"integer","description":"The maxium height the resized file should have","example":300}}}},"components/schemas/CropTransformationTemplate":{"id":"components/schemas/CropTransformationTemplate","kind":"json-schema","title":"CropTransformationTemplate","data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["CROP"]}}}},"components/schemas/ConvertTransformationTemplate":{"id":"components/schemas/ConvertTransformationTemplate","kind":"json-schema","title":"ConvertTransformationTemplate","data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["CONVERT"]},"mediaType":{"description":"The media type to convert to","$ref":"#/components/schemas/MediaType"}}}},"components/schemas/TransformationTemplate":{"id":"components/schemas/TransformationTemplate","kind":"json-schema","title":"TransformationTemplate","data":{"oneOf":[{"$ref":"#/components/schemas/ResizeTransformationTemplate"},{"$ref":"#/components/schemas/CropTransformationTemplate"},{"$ref":"#/components/schemas/ConvertTransformationTemplate"}],"discriminator":{"propertyName":"type","mapping":{"RESIZE":"#/components/schemas/ResizeTransformationTemplate","CROP":"#/components/schemas/CropTransformationTemplate","CONVERT":"#/components/schemas/ConvertTransformationTemplate"}}}},"components/schemas/CandidatePresetTransformation":{"id":"components/schemas/CandidatePresetTransformation","kind":"json-schema","title":"CandidatePresetTransformation","data":{"type":"object","required":["criteria","transformationTemplate"],"properties":{"criteria":{"type":"array","items":{"$ref":"#/components/schemas/TransformationCriterion"}},"transformationTemplate":{"type":"array","items":{"$ref":"#/components/schemas/TransformationTemplate"}}}}},"components/schemas/PresetTransformation":{"id":"components/schemas/PresetTransformation","kind":"json-schema","title":"PresetTransformation","data":{"type":"object","required":["id","accountId","name","position","candidatePresetTransformations"],"properties":{"id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PresetTransformation"},"children":[]}]}]}],"type":"string","example":"a060635d-5807-4115-a2ed-f0588d47e7ba"},"accountId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the preset transformation belongs to"},"children":[]}]}]}],"type":"string","example":"cfb665ca-ce35-4418-b9d5-70ee815db4bd"},"name":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Human readable name of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PresetTransformation"},"children":[]}]}]}],"type":"string","example":"Medium"},"position":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The 0-based position the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PresetTransformation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has in relation to other presets for the group it is in."},"children":[]}]}]}],"type":"integer","example":1},"candidatePresetTransformations":{"type":"array","items":{"$ref":"#/components/schemas/CandidatePresetTransformation"}}}}},"components/schemas/PresetTransformationGroup":{"id":"components/schemas/PresetTransformationGroup","kind":"json-schema","title":"PresetTransformationGroup","data":{"type":"object","required":["id","name","iconUrl","items"],"properties":{"id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PresetTransformationGroup"},"children":[]}]}]}],"type":"string","example":"ce809f3d-c9e1-4802-9aa9-620c0bf00dd6"},"name":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Human readable name of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PresetTransformationGroup"},"children":[]}]}]}],"type":"string","example":"LinkedIn"},"iconUrl":{"description":"URL for an icon to display alongside the group","type":"string","example":"https://planto.dash.app/assets/images/social-icons/linkedin.svg"},"items":{"type":"array","items":{"$ref":"#/components/schemas/PresetTransformation"}}}}},"components/schemas/PresetTransformationGroupType":{"id":"components/schemas/PresetTransformationGroupType","kind":"json-schema","title":"PresetTransformationGroupType","data":{"type":"object","required":["id","name","groups"],"properties":{"id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PresetTransformationGroupType"},"children":[]}]}]}],"type":"string","example":"1080e904-187c-4e65-8b40-d93e63c391dc"},"name":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Human readable name of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PresetTransformationGroupType"},"children":[]}]}]}],"type":"string","example":"Social media sizes"},"groups":{"type":"array","items":{"$ref":"#/components/schemas/PresetTransformationGroup"}}}}},"components/schemas/GroupedPresetTransformations":{"id":"components/schemas/GroupedPresetTransformations","kind":"json-schema","title":"GroupedPresetTransformations","data":{"type":"object","required":["itemGroupTypes","ungroupedItems"],"properties":{"itemGroupTypes":{"type":"array","items":{"$ref":"#/components/schemas/PresetTransformationGroupType"}},"ungroupedItems":{"type":"array","items":{"$ref":"#/components/schemas/PresetTransformation"}}}}},"components/schemas/GroupedPresetTransformationsWithPermittedActions":{"id":"components/schemas/GroupedPresetTransformationsWithPermittedActions","kind":"json-schema","title":"GroupedPresetTransformationsWithPermittedActions","data":{"type":"object","required":["result","permittedActions"],"properties":{"result":{"$ref":"#/components/schemas/GroupedPresetTransformations"},"permittedActions":{"type":"array","items":{"$ref":"#/components/schemas/PermittedAction"}}}}},"components/schemas/PresetTransformationHasTransformationOfTypeSearchCriterion":{"id":"components/schemas/PresetTransformationHasTransformationOfTypeSearchCriterion","kind":"json-schema","title":"PresetTransformationHasTransformationOfTypeSearchCriterion","data":{"type":"object","properties":{"type":{"type":"string","enum":["HAS_TRANSFORMATION_OF_TYPE"]},"transformationType":{"type":"string","enum":["CROP","RESIZE","CONVERT","CONVERT_BITRATE"]}}}},"components/schemas/PresetTransformationApplicableForAnyAssetsSearchCriterion":{"id":"components/schemas/PresetTransformationApplicableForAnyAssetsSearchCriterion","kind":"json-schema","title":"PresetTransformationApplicableForAnyAssetsSearchCriterion","data":{"type":"object","properties":{"type":{"type":"string","enum":["APPLICABLE_FOR_ANY_ASSETS"]},"assetIds":{"type":"array","items":{"type":"string"}}}}},"components/schemas/PresetTransformationSearchCriterion":{"id":"components/schemas/PresetTransformationSearchCriterion","kind":"json-schema","title":"PresetTransformationSearchCriterion","data":{"oneOf":[{"$ref":"#/components/schemas/PresetTransformationHasTransformationOfTypeSearchCriterion"},{"$ref":"#/components/schemas/PresetTransformationApplicableForAnyAssetsSearchCriterion"},{"$ref":"#/components/schemas/MatchAllSearchCriterion"},{"$ref":"#/components/schemas/PresetTransformationAndSearchCriterion"},{"$ref":"#/components/schemas/PresetTransformationOrSearchCriterion"},{"$ref":"#/components/schemas/PresetTransformationNotSearchCriterion"}],"discriminator":{"propertyName":"type","mapping":{"HAS_TRANSFORMATION_OF_TYPE":"#/components/schemas/PresetTransformationHasTransformationOfTypeSearchCriterion","APPLICABLE_FOR_ANY_ASSETS":"#/components/schemas/PresetTransformationApplicableForAnyAssetsSearchCriterion","MATCH_ALL":"#/components/schemas/MatchAllSearchCriterion","AND":"#/components/schemas/PresetTransformationAndSearchCriterion","OR":"#/components/schemas/PresetTransformationOrSearchCriterion","NOT":"#/components/schemas/PresetTransformationNotSearchCriterion"}}}},"components/schemas/PresetTransformationAndSearchCriterion":{"id":"components/schemas/PresetTransformationAndSearchCriterion","kind":"json-schema","title":"PresetTransformationAndSearchCriterion","data":{"allOf":[{"$ref":"#/components/schemas/SearchCriterion"},{"type":"object","properties":{"criteria":{"type":"array","description":"The list of criteria to AND together","items":{"$ref":"#/components/schemas/PresetTransformationSearchCriterion"}}}}]}},"components/schemas/PresetTransformationOrSearchCriterion":{"id":"components/schemas/PresetTransformationOrSearchCriterion","kind":"json-schema","title":"PresetTransformationOrSearchCriterion","data":{"allOf":[{"$ref":"#/components/schemas/SearchCriterion"},{"type":"object","properties":{"criteria":{"type":"array","description":"The list of criteria to OR together","items":{"$ref":"#/components/schemas/PresetTransformationSearchCriterion"}}}}]}},"components/schemas/PresetTransformationNotSearchCriterion":{"id":"components/schemas/PresetTransformationNotSearchCriterion","kind":"json-schema","title":"PresetTransformationNotSearchCriterion","data":{"allOf":[{"$ref":"#/components/schemas/SearchCriterion"},{"type":"object","properties":{"criterion":{"description":"The criterion to negate","$ref":"#/components/schemas/PresetTransformationSearchCriterion"}}}]}},"components/schemas/PresetTransformationSort":{"id":"components/schemas/PresetTransformationSort","kind":"json-schema","title":"PresetTransformationSort","data":{"type":"object","properties":{"field":{"type":"string","enum":["ID"]},"order":{"$ref":"#/components/schemas/SortOrder"}}}},"components/schemas/PresetTransformationSearchRequest":{"id":"components/schemas/PresetTransformationSearchRequest","kind":"json-schema","title":"PresetTransformationSearchRequest","data":{"allOf":[{"$ref":"#/components/schemas/BasePaginatedSearchInAccountRequest"},{"type":"object","properties":{"criterion":{"description":"The search criterion","$ref":"#/components/schemas/PresetTransformationSearchCriterion"},"sorts":{"description":"Sorts to be applied to the search in order of precedence","type":"array","items":{"$ref":"#/components/schemas/PresetTransformationSort"}}}}]}},"components/schemas/PresetTransformationWithPermittedActions":{"id":"components/schemas/PresetTransformationWithPermittedActions","kind":"json-schema","title":"PresetTransformationWithPermittedActions","data":{"type":"object","required":["result","permittedActions"],"properties":{"result":{"$ref":"#/components/schemas/PresetTransformation"},"permittedActions":{"type":"array","items":{"$ref":"#/components/schemas/PermittedAction"}}}}},"components/schemas/PresetTransformationSearch":{"id":"components/schemas/PresetTransformationSearch","kind":"json-schema","title":"PresetTransformationSearch","data":{"type":"object","properties":{"results":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The specified page of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Preset-Transformations"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PresetTransformation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources  which match the search criterion"},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/PresetTransformationWithPermittedActions"}},"totalResults":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total number of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Preset-Transformations"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PresetTransformation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources which match the search criterion"},"children":[]}]}]}],"example":1337}}}},"components/schemas/PresetTransformationsForAssetSearchField":{"id":"components/schemas/PresetTransformationsForAssetSearchField","kind":"json-schema","title":"PresetTransformationsForAssetSearchField","data":{"type":"string","enum":["ASSET_ID"],"example":"ASSET_ID","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the ["},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PresetTransformationsForAsset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"] property value"},"children":[]}]}]}]}},"components/schemas/PresetTransformationsForAssetFieldInSearchCriterion":{"id":"components/schemas/PresetTransformationsForAssetFieldInSearchCriterion","kind":"json-schema","title":"PresetTransformationsForAssetFieldInSearchCriterion","data":{"allOf":[{"$ref":"#/components/schemas/FieldInSearchCriterion"},{"type":"object","required":["type","values"],"properties":{"type":{"type":"string","enum":["FIELD_IN"]},"field":{"$ref":"#/components/schemas/PresetTransformationsForAssetSearchField"}}}]}},"components/schemas/PresetTransformationsForAssetSearchCriterion":{"id":"components/schemas/PresetTransformationsForAssetSearchCriterion","kind":"json-schema","title":"PresetTransformationsForAssetSearchCriterion","data":{"oneOf":[{"$ref":"#/components/schemas/PresetTransformationsForAssetFieldInSearchCriterion"}],"discriminator":{"propertyName":"type","mapping":{"FIELD_IN":"#/components/schemas/PresetTransformationsForAssetFieldInSearchCriterion"}}}},"components/schemas/PresetTransformationsForAssetSort":{"id":"components/schemas/PresetTransformationsForAssetSort","kind":"json-schema","title":"PresetTransformationsForAssetSort","data":{"type":"object","required":["field","order"],"properties":{"field":{"type":"string","enum":["ASSET_ID"]},"order":{"$ref":"#/components/schemas/SortOrder"}}}},"components/schemas/PresetTransformationsForAssetSearchRequest":{"id":"components/schemas/PresetTransformationsForAssetSearchRequest","kind":"json-schema","title":"PresetTransformationsForAssetSearchRequest","data":{"allOf":[{"$ref":"#/components/schemas/BasePaginatedSearchInAccountRequest"},{"type":"object","required":["criterion","sorts"],"properties":{"criterion":{"description":"The search criterion","$ref":"#/components/schemas/PresetTransformationsForAssetSearchCriterion"},"sorts":{"description":"Sorts to be applied to the search in order of precedence","type":"array","items":{"$ref":"#/components/schemas/PresetTransformationsForAssetSort"}}}}]}},"components/schemas/PresetTransformationsForAsset":{"id":"components/schemas/PresetTransformationsForAsset","kind":"json-schema","title":"PresetTransformationsForAsset","data":{"type":"object","required":["assetId","presetTransformationIds"],"properties":{"assetId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]}]}],"type":"string","example":"7af90a8b-7ccd-430f-a85d-e8614015bc47"},"presetTransformationIds":{"type":"array","items":{"type":"string"}}}}},"components/schemas/PresetTransformationsForAssetWithPermittedActions":{"id":"components/schemas/PresetTransformationsForAssetWithPermittedActions","kind":"json-schema","title":"PresetTransformationsForAssetWithPermittedActions","data":{"type":"object","required":["result","permittedActions"],"properties":{"result":{"$ref":"#/components/schemas/PresetTransformationsForAsset"},"permittedActions":{"type":"array","items":{"$ref":"#/components/schemas/PermittedAction"}}}}},"components/schemas/PresetTransformationsForAssetSearch":{"id":"components/schemas/PresetTransformationsForAssetSearch","kind":"json-schema","title":"PresetTransformationsForAssetSearch","data":{"type":"object","properties":{"results":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The specified page of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PresetTransformationsForAsset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources  which match the search criterion"},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/PresetTransformationsForAssetWithPermittedActions"}},"totalResults":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total number of ["},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PresetTransformationsForAsset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"] resources which match the search criterion"},"children":[]}]}]}],"example":1337}}}},"components/schemas/ProductMetadata":{"id":"components/schemas/ProductMetadata","kind":"json-schema","title":"ProductMetadata","data":{"type":"object","required":["version","values"],"properties":{"version":{"type":"integer","description":"The current version number of the product metadata","example":11},"values":{"type":"object","additionalProperties":{"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":"Map of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field.id"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" keys to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"string[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the referenced "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field.multiValue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" then the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"string[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will contain "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the referenced "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field.multiValue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" then the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"string[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will contain "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0-1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The absence of a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field.id"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the map is equivalent to a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"string[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the referenced "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field.hasFixedOptions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" then each item in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"string[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption.id"},"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":"If the referenced "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field.hasFixedOptions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" then each item in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"string[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will itself be a human-readable value."},"children":[]}]}]}]},"example":{"a52b5315-15b8-417f-b742-d6902108bac1":["A product title"],"f992794c-85db-11eb-8dcd-0242ac130003":["Apparel","Summer"]}}}}},"components/schemas/Product":{"id":"components/schemas/Product","kind":"json-schema","title":"Product","data":{"type":"object","required":["id","accountId","name","variantDefinitionFieldIds","variantCount","metadata"],"properties":{"id":{"type":"string","description":"The unique ID for the product","example":"7af90a8b-7ccd-430f-a85d-e8614015bc47"},"accountId":{"type":"string","description":"The ID of the account the product belongs to","example":"cfb665ca-ce35-4418-b9d5-70ee815db4bd"},"name":{"type":"string","description":"The name of the product","example":"Diet Slurm"},"variantCount":{"type":"number","description":"The number of variants for this product","example":50},"variantDefinitionFieldIds":{"type":"array","description":"The field IDs whose values define the product's variants","items":{"type":"string"},"example":["a52b5315-15b8-417f-b742-d6902108bac1","f992794c-85db-11eb-8dcd-0242ac130003"]},"metadata":{"$ref":"#/components/schemas/ProductMetadata"}}}},"components/schemas/ProductWithPermittedActions":{"id":"components/schemas/ProductWithPermittedActions","kind":"json-schema","title":"ProductWithPermittedActions","data":{"type":"object","required":["result","permittedActions"],"properties":{"result":{"$ref":"#/components/schemas/Product"},"permittedActions":{"type":"array","description":"Permitted actions for product resources","items":{"$ref":"#/components/schemas/PermittedAction"}}}}},"components/schemas/ProductSearchFieldFixed":{"id":"components/schemas/ProductSearchFieldFixed","kind":"json-schema","title":"ProductSearchFieldFixed","data":{"type":"object","required":["type","fieldName"],"properties":{"type":{"type":"string","enum":["FIXED"]},"fieldName":{"type":"string","enum":["ID","KEYWORDS","NAME","PRODUCT_VARIANT_ID","PRODUCT_VARIANT_SKU"],"example":"KEYWORDS","description":"The name of the fixed product property value used to search on."}}}},"components/schemas/ProductSearchFieldField":{"id":"components/schemas/ProductSearchFieldField","kind":"json-schema","title":"ProductSearchFieldField","data":{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["FIELD"]},"fieldId":{"type":"string","example":"a52b5315-15b8-417f-b742-d6902108bac1","description":[{"$$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":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field.id"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to which the criterion applies."},"children":[]}]}]}]}}}},"components/schemas/ProductSearchField":{"id":"components/schemas/ProductSearchField","kind":"json-schema","title":"ProductSearchField","data":{"oneOf":[{"$ref":"#/components/schemas/ProductSearchFieldFixed"},{"$ref":"#/components/schemas/ProductSearchFieldField"}],"discriminator":{"propertyName":"type","mapping":{"FIXED":"#/components/schemas/ProductSearchFieldFixed","FIELD":"#/components/schemas/ProductSearchFieldField"}}}},"components/schemas/ProductFieldEqualsSearchCriterion":{"id":"components/schemas/ProductFieldEqualsSearchCriterion","kind":"json-schema","title":"ProductFieldEqualsSearchCriterion","data":{"allOf":[{"$ref":"#/components/schemas/FieldEqualsSearchCriterion"},{"type":"object","required":["type","field"],"properties":{"type":{"type":"string","enum":["FIELD_EQUALS"]},"field":{"$ref":"#/components/schemas/ProductSearchField"},"includeDescendants":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the field is hierarchical, then a value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will include products with descendant field values, while "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will include only products with the field value specified."},"children":[]}]}]}],"default":true},"boost":{"type":"number","description":"A floating-point value that specifies the weight of this field toward the relevance score. Values above 1.0 increase the field's relevance. Values between 0.0 and 1.0 decrease the field's relevance. Default is 1.0.","nullable":true,"default":null}}}]}},"components/schemas/ProductFieldHasAnyEqualSearchCriterion":{"id":"components/schemas/ProductFieldHasAnyEqualSearchCriterion","kind":"json-schema","title":"ProductFieldHasAnyEqualSearchCriterion","data":{"allOf":[{"$ref":"#/components/schemas/FieldInSearchCriterion"},{"type":"object","required":["type","field"],"properties":{"type":{"type":"string","enum":["FIELD_HAS_ANY_EQUAL"]},"field":{"$ref":"#/components/schemas/ProductSearchField"},"includeDescendants":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the field is hierarchical, then a value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will include products with descendant field values, while "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will include only products with the field value specified."},"children":[]}]}]}],"default":true},"boost":{"type":"number","description":"A floating-point value that specifies the weight of this field toward the relevance score. Values above 1.0 increase the field's relevance. Values between 0.0 and 1.0 decrease the field's relevance. Default is 1.0.","nullable":true,"default":null}}}]}},"components/schemas/ProductFieldHasAllEqualSearchCriterion":{"id":"components/schemas/ProductFieldHasAllEqualSearchCriterion","kind":"json-schema","title":"ProductFieldHasAllEqualSearchCriterion","data":{"allOf":[{"$ref":"#/components/schemas/FieldInSearchCriterion"},{"type":"object","required":["type","field"],"properties":{"type":{"type":"string","enum":["FIELD_HAS_ALL_EQUAL"]},"field":{"$ref":"#/components/schemas/ProductSearchField"},"includeDescendants":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the field is hierarchical, then a value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will include products with descendant field values, while "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will include only products with the field value specified."},"children":[]}]}]}],"default":true},"boost":{"type":"number","description":"A floating-point value that specifies the weight of this field toward the relevance score. Values above 1.0 increase the field's relevance. Values between 0.0 and 1.0 decrease the field's relevance. Default is 1.0.","nullable":true,"default":null}}}]}},"components/schemas/ProductFieldMatchesSearchCriterion":{"id":"components/schemas/ProductFieldMatchesSearchCriterion","kind":"json-schema","title":"ProductFieldMatchesSearchCriterion","data":{"allOf":[{"$ref":"#/components/schemas/FieldMatchesSearchCriterion"},{"type":"object","required":["type","field"],"properties":{"type":{"type":"string","enum":["FIELD_MATCHES"]},"field":{"$ref":"#/components/schemas/ProductSearchField"},"boost":{"type":"number","description":"A floating-point value that specifies the weight of this field toward the relevance score. Values above 1.0 increase the field's relevance. Values between 0.0 and 1.0 decrease the field's relevance. Default is 1.0.","nullable":true,"default":null}}}]}},"components/schemas/ProductFieldIsEmptySearchCriterion":{"id":"components/schemas/ProductFieldIsEmptySearchCriterion","kind":"json-schema","title":"ProductFieldIsEmptySearchCriterion","data":{"allOf":[{"$ref":"#/components/schemas/FieldIsEmptySearchCriterion"},{"type":"object","required":["type","field"],"properties":{"type":{"type":"string","enum":["FIELD_IS_EMPTY"]},"field":{"$ref":"#/components/schemas/ProductSearchField"}}}]}},"components/schemas/ProductSearchCriterion":{"id":"components/schemas/ProductSearchCriterion","kind":"json-schema","title":"ProductSearchCriterion","data":{"oneOf":[{"$ref":"#/components/schemas/ProductFieldEqualsSearchCriterion"},{"$ref":"#/components/schemas/ProductFieldHasAnyEqualSearchCriterion"},{"$ref":"#/components/schemas/ProductFieldHasAllEqualSearchCriterion"},{"$ref":"#/components/schemas/ProductFieldMatchesSearchCriterion"},{"$ref":"#/components/schemas/ProductFieldIsEmptySearchCriterion"},{"$ref":"#/components/schemas/ProductAndSearchCriterion"},{"$ref":"#/components/schemas/ProductOrSearchCriterion"},{"$ref":"#/components/schemas/ProductNotSearchCriterion"},{"$ref":"#/components/schemas/MatchAllSearchCriterion"},{"$ref":"#/components/schemas/MatchNoneSearchCriterion"}],"discriminator":{"propertyName":"type","mapping":{"FIELD_EQUALS":"#/components/schemas/ProductFieldEqualsSearchCriterion","FIELD_HAS_ANY_EQUAL":"#/components/schemas/ProductFieldHasAnyEqualSearchCriterion","FIELD_HAS_ALL_EQUAL":"#/components/schemas/ProductFieldHasAllEqualSearchCriterion","FIELD_MATCHES":"#/components/schemas/ProductFieldMatchesSearchCriterion","FIELD_IS_EMPTY":"#/components/schemas/ProductFieldIsEmptySearchCriterion","MATCH_ALL":"#/components/schemas/MatchAllSearchCriterion","MATCH_NONE":"#/components/schemas/MatchNoneSearchCriterion","AND":"#/components/schemas/ProductAndSearchCriterion","OR":"#/components/schemas/ProductOrSearchCriterion","NOT":"#/components/schemas/ProductNotSearchCriterion"}}}},"components/schemas/ProductAndSearchCriterion":{"id":"components/schemas/ProductAndSearchCriterion","kind":"json-schema","title":"ProductAndSearchCriterion","data":{"allOf":[{"$ref":"#/components/schemas/SearchCriterion"},{"type":"object","required":["type","criteria"],"properties":{"type":{"type":"string","enum":["AND"]},"criteria":{"type":"array","description":"The list of criteria to AND together","items":{"$ref":"#/components/schemas/ProductSearchCriterion"}}}}]}},"components/schemas/ProductOrSearchCriterion":{"id":"components/schemas/ProductOrSearchCriterion","kind":"json-schema","title":"ProductOrSearchCriterion","data":{"allOf":[{"$ref":"#/components/schemas/SearchCriterion"},{"type":"object","required":["type","criteria"],"properties":{"type":{"type":"string","enum":["OR"]},"criteria":{"type":"array","description":"The list of criteria to OR together","items":{"$ref":"#/components/schemas/ProductSearchCriterion"}}}}]}},"components/schemas/ProductNotSearchCriterion":{"id":"components/schemas/ProductNotSearchCriterion","kind":"json-schema","title":"ProductNotSearchCriterion","data":{"allOf":[{"$ref":"#/components/schemas/SearchCriterion"},{"type":"object","required":["type","criterion"],"properties":{"type":{"type":"string","enum":["NOT"]},"criterion":{"$ref":"#/components/schemas/ProductSearchCriterion"}}}]}},"components/schemas/ProductSortFieldFixed":{"id":"components/schemas/ProductSortFieldFixed","kind":"json-schema","title":"ProductSortFieldFixed","data":{"type":"object","required":["type","fieldName"],"properties":{"type":{"type":"string","enum":["FIXED"]},"fieldName":{"type":"string","enum":["ID","NAME","RELEVANCE"],"example":"RELEVANCE","description":"The name of the fixed product property value used to sort on."}}}},"components/schemas/ProductSortFieldField":{"id":"components/schemas/ProductSortFieldField","kind":"json-schema","title":"ProductSortFieldField","data":{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["FIELD"]},"fieldId":{"type":"string","example":"a52b5315-15b8-417f-b742-d6902108bac1","description":[{"$$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":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field.id"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to which the sort applies."},"children":[]}]}]}]}}}},"components/schemas/ProductSortField":{"id":"components/schemas/ProductSortField","kind":"json-schema","title":"ProductSortField","data":{"oneOf":[{"$ref":"#/components/schemas/ProductSortFieldFixed"},{"$ref":"#/components/schemas/ProductSortFieldField"}],"discriminator":{"propertyName":"type","mapping":{"FIXED":"#/components/schemas/ProductSortFieldFixed","FIELD":"#/components/schemas/ProductSortFieldField"}}}},"components/schemas/ProductSort":{"id":"components/schemas/ProductSort","kind":"json-schema","title":"ProductSort","data":{"type":"object","required":["field","order"],"properties":{"field":{"$ref":"#/components/schemas/ProductSortField"},"order":{"$ref":"#/components/schemas/SortOrder"}}}},"components/schemas/BaseProductSearchRequest":{"id":"components/schemas/BaseProductSearchRequest","kind":"json-schema","title":"BaseProductSearchRequest","data":{"type":"object","required":["criterion","sorts"],"properties":{"criterion":{"description":"The search criterion","$ref":"#/components/schemas/ProductSearchCriterion"},"sorts":{"description":"Sorts to be applied to the search in order of precedence","type":"array","items":{"$ref":"#/components/schemas/ProductSort"}}}}},"components/schemas/ProductAggregationRequestInclusionOptions":{"id":"components/schemas/ProductAggregationRequestInclusionOptions","kind":"json-schema","title":"ProductAggregationRequestInclusionOptions","data":{"type":"object","description":"Field values to include and/or exclude in the aggregation. Exclusions take precedence over inclusions.","properties":{"includeTerms":{"type":"array","description":"If set, only the listed field values will be included in the aggregation","items":{"type":"string"}},"excludeTerms":{"type":"array","description":"If set, all listed field values will be excluded from the aggregation","items":{"type":"string"}}}}},"components/schemas/ProductTermsAggregationRequest":{"id":"components/schemas/ProductTermsAggregationRequest","kind":"json-schema","title":"ProductTermsAggregationRequest","data":{"type":"object","required":["type","field"],"properties":{"type":{"type":"string"},"field":{"$ref":"#/components/schemas/ProductSearchField"},"valueWhenMissing":{"type":"string","description":"The value to assign to products that do not have a value for the field that you are aggregating upon","example":"Unknown"},"inclusionOptions":{"$ref":"#/components/schemas/ProductAggregationRequestInclusionOptions"}}}},"components/schemas/ProductAggregationRequest":{"id":"components/schemas/ProductAggregationRequest","kind":"json-schema","title":"ProductAggregationRequest","data":{"oneOf":[{"$ref":"#/components/schemas/ProductTermsAggregationRequest"}],"discriminator":{"propertyName":"type","mapping":{"TERMS":"#/components/schemas/ProductTermsAggregationRequest"}}}},"components/schemas/ProductAggregationRequestsMap":{"id":"components/schemas/ProductAggregationRequestsMap","kind":"json-schema","title":"ProductAggregationRequestsMap","data":{"type":"object","properties":{"aggregations":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ProductAggregationRequest"},"description":"A map of requested aggregations. The results will be returned in a map with the same provided keys."}}}},"components/schemas/ProductPaginatedSearchRequest":{"id":"components/schemas/ProductPaginatedSearchRequest","kind":"json-schema","title":"ProductPaginatedSearchRequest","data":{"allOf":[{"$ref":"#/components/schemas/BasePaginatedSearchInAccountRequest"},{"$ref":"#/components/schemas/BaseProductSearchRequest"},{"$ref":"#/components/schemas/ProductAggregationRequestsMap"}]}},"components/schemas/BaseProductSearch":{"id":"components/schemas/BaseProductSearch","kind":"json-schema","title":"BaseProductSearch","data":{"type":"object","required":["results","totalResults"],"properties":{"results":{"type":"array","description":"The requested page of products which match the search criterion","items":{"$ref":"#/components/schemas/ProductWithPermittedActions"}},"totalResults":{"type":"integer","description":"The total number of products which match the search criterion","example":1337}}}},"components/schemas/ProductAggregationBucket":{"id":"components/schemas/ProductAggregationBucket","kind":"json-schema","title":"ProductAggregationBucket","data":{"type":"object","required":["key","count"],"properties":{"key":{"type":"string","description":"The unique name of the bucket","example":"Example bucket"},"count":{"type":"integer","description":"The number of products in the bucket","example":15}}}},"components/schemas/ProductAggregationBucketResponse":{"id":"components/schemas/ProductAggregationBucketResponse","kind":"json-schema","title":"ProductAggregationBucketResponse","data":{"type":"object","required":["type","buckets"],"properties":{"type":{"type":"string"},"buckets":{"description":"The collection of unique buckets within the requested aggregation","type":"array","items":{"$ref":"#/components/schemas/ProductAggregationBucket"}}}}},"components/schemas/ProductAggregationResponse":{"id":"components/schemas/ProductAggregationResponse","kind":"json-schema","title":"ProductAggregationResponse","data":{"oneOf":[{"$ref":"#/components/schemas/ProductAggregationBucketResponse"}],"discriminator":{"propertyName":"type","mapping":{"BUCKET":"#/components/schemas/ProductAggregationBucketResponse"}}}},"components/schemas/ProductAggregationResponsesMap":{"id":"components/schemas/ProductAggregationResponsesMap","kind":"json-schema","title":"ProductAggregationResponsesMap","data":{"type":"object","properties":{"aggregations":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ProductAggregationResponse"},"description":"A map of the aggregations requested keyed on the keys provided by the user in the request."}}}},"components/schemas/ProductSearch":{"id":"components/schemas/ProductSearch","kind":"json-schema","title":"ProductSearch","data":{"allOf":[{"$ref":"#/components/schemas/BaseProductSearch"},{"$ref":"#/components/schemas/ProductAggregationResponsesMap"},{"type":"object"}]}},"components/schemas/ProductVariant":{"id":"components/schemas/ProductVariant","kind":"json-schema","title":"ProductVariant","data":{"type":"object","required":["id","name","accountId","sku","productId","metadata"],"properties":{"id":{"type":"string","description":"The unique ID for the product variant","example":"7af90a8b-7ccd-430f-a85d-e8614015bc47"},"name":{"type":"string","nullable":true,"description":"The name of the product variant","example":"Green / XL"},"sku":{"type":"string","nullable":true,"description":"The SKU of the product variant","example":"slurm-green-xl"},"productId":{"type":"string","description":"The ID of the product the product variant belongs to","example":"a52b5315-15b8-417f-b742-d6902108bac1"},"accountId":{"type":"string","description":"The ID of the account the product variant belongs to","example":"cfb665ca-ce35-4418-b9d5-70ee815db4bd"},"metadata":{"$ref":"#/components/schemas/ProductMetadata"}}}},"components/schemas/ProductVariantWithPermittedActions":{"id":"components/schemas/ProductVariantWithPermittedActions","kind":"json-schema","title":"ProductVariantWithPermittedActions","data":{"type":"object","required":["result","permittedActions"],"properties":{"result":{"$ref":"#/components/schemas/ProductVariant"},"permittedActions":{"type":"array","description":"Permitted actions for product variant resources","items":{"$ref":"#/components/schemas/PermittedAction"}}}}},"components/schemas/ProductVariantSearchFieldFixed":{"id":"components/schemas/ProductVariantSearchFieldFixed","kind":"json-schema","title":"ProductVariantSearchFieldFixed","data":{"type":"object","required":["type","fieldName"],"properties":{"type":{"type":"string","enum":["FIXED"]},"fieldName":{"type":"string","enum":["ID","NAME","PRODUCT_ID","PRODUCT_NAME","SKU","KEYWORDS"],"example":"KEYWORDS","description":"The name of the fixed product variant property value used to search on."}}}},"components/schemas/ProductVariantSearchFieldField":{"id":"components/schemas/ProductVariantSearchFieldField","kind":"json-schema","title":"ProductVariantSearchFieldField","data":{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["FIELD"]},"fieldId":{"type":"string","example":"a52b5315-15b8-417f-b742-d6902108bac1","description":[{"$$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":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field.id"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to which the criterion applies."},"children":[]}]}]}]}}}},"components/schemas/ProductVariantSearchField":{"id":"components/schemas/ProductVariantSearchField","kind":"json-schema","title":"ProductVariantSearchField","data":{"oneOf":[{"$ref":"#/components/schemas/ProductVariantSearchFieldFixed"},{"$ref":"#/components/schemas/ProductVariantSearchFieldField"}],"discriminator":{"propertyName":"type","mapping":{"FIXED":"#/components/schemas/ProductVariantSearchFieldFixed","FIELD":"#/components/schemas/ProductVariantSearchFieldField"}}}},"components/schemas/ProductVariantFieldEqualsSearchCriterion":{"id":"components/schemas/ProductVariantFieldEqualsSearchCriterion","kind":"json-schema","title":"ProductVariantFieldEqualsSearchCriterion","data":{"allOf":[{"$ref":"#/components/schemas/FieldEqualsSearchCriterion"},{"type":"object","required":["type","field"],"properties":{"type":{"type":"string","enum":["FIELD_EQUALS"]},"field":{"$ref":"#/components/schemas/ProductVariantSearchField"},"includeDescendants":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the field is hierarchical, then a value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will include product variants with descendant field values, while "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will include only product variants with the field value specified."},"children":[]}]}]}],"default":true},"boost":{"type":"number","description":"A floating-point value that specifies the weight of this field toward the relevance score. Values above 1.0 increase the field's relevance. Values between 0.0 and 1.0 decrease the field's relevance. Default is 1.0.","nullable":true,"default":null}}}]}},"components/schemas/ProductVariantFieldHasAnyEqualSearchCriterion":{"id":"components/schemas/ProductVariantFieldHasAnyEqualSearchCriterion","kind":"json-schema","title":"ProductVariantFieldHasAnyEqualSearchCriterion","data":{"allOf":[{"$ref":"#/components/schemas/FieldInSearchCriterion"},{"type":"object","required":["type","field"],"properties":{"type":{"type":"string","enum":["FIELD_HAS_ANY_EQUAL"]},"field":{"$ref":"#/components/schemas/ProductVariantSearchField"},"includeDescendants":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the field is hierarchical, then a value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will include product variants with descendant field values, while "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will include only product variants with the field value specified."},"children":[]}]}]}],"default":true},"boost":{"type":"number","description":"A floating-point value that specifies the weight of this field toward the relevance score. Values above 1.0 increase the field's relevance. Values between 0.0 and 1.0 decrease the field's relevance. Default is 1.0.","nullable":true,"default":null}}}]}},"components/schemas/ProductVariantFieldHasAllEqualSearchCriterion":{"id":"components/schemas/ProductVariantFieldHasAllEqualSearchCriterion","kind":"json-schema","title":"ProductVariantFieldHasAllEqualSearchCriterion","data":{"allOf":[{"$ref":"#/components/schemas/FieldInSearchCriterion"},{"type":"object","required":["type","field"],"properties":{"type":{"type":"string","enum":["FIELD_HAS_ALL_EQUAL"]},"field":{"$ref":"#/components/schemas/ProductVariantSearchField"},"includeDescendants":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the field is hierarchical, then a value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will include product variants with descendant field values, while "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will include only product variants with the field value specified."},"children":[]}]}]}],"default":true},"boost":{"type":"number","description":"A floating-point value that specifies the weight of this field toward the relevance score. Values above 1.0 increase the field's relevance. Values between 0.0 and 1.0 decrease the field's relevance. Default is 1.0.","nullable":true,"default":null}}}]}},"components/schemas/ProductVariantFieldMatchesSearchCriterion":{"id":"components/schemas/ProductVariantFieldMatchesSearchCriterion","kind":"json-schema","title":"ProductVariantFieldMatchesSearchCriterion","data":{"allOf":[{"$ref":"#/components/schemas/FieldMatchesSearchCriterion"},{"type":"object","required":["type","field"],"properties":{"type":{"type":"string","enum":["FIELD_MATCHES"]},"field":{"$ref":"#/components/schemas/ProductVariantSearchField"},"boost":{"type":"number","description":"A floating-point value that specifies the weight of this field toward the relevance score. Values above 1.0 increase the field's relevance. Values between 0.0 and 1.0 decrease the field's relevance. Default is 1.0.","nullable":true,"default":null}}}]}},"components/schemas/ProductVariantFieldIsEmptySearchCriterion":{"id":"components/schemas/ProductVariantFieldIsEmptySearchCriterion","kind":"json-schema","title":"ProductVariantFieldIsEmptySearchCriterion","data":{"allOf":[{"$ref":"#/components/schemas/FieldIsEmptySearchCriterion"},{"type":"object","required":["type","field"],"properties":{"type":{"type":"string","enum":["FIELD_IS_EMPTY"]},"field":{"$ref":"#/components/schemas/ProductVariantSearchField"}}}]}},"components/schemas/ProductVariantSearchCriterion":{"id":"components/schemas/ProductVariantSearchCriterion","kind":"json-schema","title":"ProductVariantSearchCriterion","data":{"oneOf":[{"$ref":"#/components/schemas/ProductVariantFieldEqualsSearchCriterion"},{"$ref":"#/components/schemas/ProductVariantFieldHasAnyEqualSearchCriterion"},{"$ref":"#/components/schemas/ProductVariantFieldHasAllEqualSearchCriterion"},{"$ref":"#/components/schemas/ProductVariantFieldMatchesSearchCriterion"},{"$ref":"#/components/schemas/ProductVariantFieldIsEmptySearchCriterion"},{"$ref":"#/components/schemas/ProductVariantAndSearchCriterion"},{"$ref":"#/components/schemas/ProductVariantOrSearchCriterion"},{"$ref":"#/components/schemas/ProductVariantNotSearchCriterion"},{"$ref":"#/components/schemas/MatchAllSearchCriterion"},{"$ref":"#/components/schemas/MatchNoneSearchCriterion"}],"discriminator":{"propertyName":"type","mapping":{"FIELD_EQUALS":"#/components/schemas/ProductVariantFieldEqualsSearchCriterion","FIELD_HAS_ANY_EQUAL":"#/components/schemas/ProductVariantFieldHasAnyEqualSearchCriterion","FIELD_HAS_ALL_EQUAL":"#/components/schemas/ProductVariantFieldHasAllEqualSearchCriterion","FIELD_MATCHES":"#/components/schemas/ProductVariantFieldMatchesSearchCriterion","FIELD_IS_EMPTY":"#/components/schemas/ProductVariantFieldIsEmptySearchCriterion","MATCH_ALL":"#/components/schemas/MatchAllSearchCriterion","MATCH_NONE":"#/components/schemas/MatchNoneSearchCriterion","AND":"#/components/schemas/ProductVariantAndSearchCriterion","OR":"#/components/schemas/ProductVariantOrSearchCriterion","NOT":"#/components/schemas/ProductVariantNotSearchCriterion"}}}},"components/schemas/ProductVariantAndSearchCriterion":{"id":"components/schemas/ProductVariantAndSearchCriterion","kind":"json-schema","title":"ProductVariantAndSearchCriterion","data":{"allOf":[{"$ref":"#/components/schemas/SearchCriterion"},{"type":"object","required":["type","criteria"],"properties":{"type":{"type":"string","enum":["AND"]},"criteria":{"type":"array","description":"The list of criteria to AND together","items":{"$ref":"#/components/schemas/ProductVariantSearchCriterion"}}}}]}},"components/schemas/ProductVariantOrSearchCriterion":{"id":"components/schemas/ProductVariantOrSearchCriterion","kind":"json-schema","title":"ProductVariantOrSearchCriterion","data":{"allOf":[{"$ref":"#/components/schemas/SearchCriterion"},{"type":"object","required":["type","criteria"],"properties":{"type":{"type":"string","enum":["OR"]},"criteria":{"type":"array","description":"The list of criteria to OR together","items":{"$ref":"#/components/schemas/ProductVariantSearchCriterion"}}}}]}},"components/schemas/ProductVariantNotSearchCriterion":{"id":"components/schemas/ProductVariantNotSearchCriterion","kind":"json-schema","title":"ProductVariantNotSearchCriterion","data":{"allOf":[{"$ref":"#/components/schemas/SearchCriterion"},{"type":"object","required":["type","criterion"],"properties":{"type":{"type":"string","enum":["NOT"]},"criterion":{"$ref":"#/components/schemas/ProductVariantSearchCriterion"}}}]}},"components/schemas/ProductVariantSortFieldFixed":{"id":"components/schemas/ProductVariantSortFieldFixed","kind":"json-schema","title":"ProductVariantSortFieldFixed","data":{"type":"object","required":["type","fieldName"],"properties":{"type":{"type":"string","enum":["FIXED"]},"fieldName":{"type":"string","enum":["ID","NAME","RELEVANCE"],"example":"RELEVANCE","description":"The name of the fixed product variant property value used to sort on."}}}},"components/schemas/ProductVariantSortFieldField":{"id":"components/schemas/ProductVariantSortFieldField","kind":"json-schema","title":"ProductVariantSortFieldField","data":{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["FIELD"]},"fieldId":{"type":"string","example":"a52b5315-15b8-417f-b742-d6902108bac1","description":[{"$$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":"link","inline":true,"attributes":{"href":"/dash/openapi/Fields"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Field.id"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to which the sort applies."},"children":[]}]}]}]}}}},"components/schemas/ProductVariantSortField":{"id":"components/schemas/ProductVariantSortField","kind":"json-schema","title":"ProductVariantSortField","data":{"oneOf":[{"$ref":"#/components/schemas/ProductVariantSortFieldFixed"},{"$ref":"#/components/schemas/ProductVariantSortFieldField"}],"discriminator":{"propertyName":"type","mapping":{"FIXED":"#/components/schemas/ProductVariantSortFieldFixed","FIELD":"#/components/schemas/ProductVariantSortFieldField"}}}},"components/schemas/ProductVariantSort":{"id":"components/schemas/ProductVariantSort","kind":"json-schema","title":"ProductVariantSort","data":{"type":"object","required":["field","order"],"properties":{"field":{"$ref":"#/components/schemas/ProductVariantSortField"},"order":{"$ref":"#/components/schemas/SortOrder"}}}},"components/schemas/BaseProductVariantSearchRequest":{"id":"components/schemas/BaseProductVariantSearchRequest","kind":"json-schema","title":"BaseProductVariantSearchRequest","data":{"type":"object","required":["criterion","sorts"],"properties":{"criterion":{"description":"The search criterion","$ref":"#/components/schemas/ProductVariantSearchCriterion"},"sorts":{"description":"Sorts to be applied to the search in order of precedence","type":"array","items":{"$ref":"#/components/schemas/ProductVariantSort"}}}}},"components/schemas/ProductVariantAggregationRequestInclusionOptions":{"id":"components/schemas/ProductVariantAggregationRequestInclusionOptions","kind":"json-schema","title":"ProductVariantAggregationRequestInclusionOptions","data":{"type":"object","description":"Field values to include and/or exclude in the aggregation. Exclusions take precedence over inclusions.","properties":{"includeTerms":{"type":"array","description":"If set, only the listed field values will be included in the aggregation","items":{"type":"string"}},"excludeTerms":{"type":"array","description":"If set, all listed field values will be excluded from the aggregation","items":{"type":"string"}}}}},"components/schemas/ProductVariantTermsAggregationRequest":{"id":"components/schemas/ProductVariantTermsAggregationRequest","kind":"json-schema","title":"ProductVariantTermsAggregationRequest","data":{"type":"object","required":["type","field"],"properties":{"type":{"type":"string"},"field":{"$ref":"#/components/schemas/ProductVariantSearchField"},"valueWhenMissing":{"type":"string","description":"The value to assign to product variants that do not have a value for the field that you are aggregating upon","example":"Unknown"},"inclusionOptions":{"$ref":"#/components/schemas/ProductVariantAggregationRequestInclusionOptions"}}}},"components/schemas/ProductVariantAggregationRequest":{"id":"components/schemas/ProductVariantAggregationRequest","kind":"json-schema","title":"ProductVariantAggregationRequest","data":{"oneOf":[{"$ref":"#/components/schemas/ProductVariantTermsAggregationRequest"}],"discriminator":{"propertyName":"type","mapping":{"TERMS":"#/components/schemas/ProductVariantTermsAggregationRequest"}}}},"components/schemas/ProductVariantAggregationRequestsMap":{"id":"components/schemas/ProductVariantAggregationRequestsMap","kind":"json-schema","title":"ProductVariantAggregationRequestsMap","data":{"type":"object","properties":{"aggregations":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ProductVariantAggregationRequest"},"description":"A map of requested aggregations. The results will be returned in a map with the same provided keys."}}}},"components/schemas/ProductVariantPaginatedSearchRequest":{"id":"components/schemas/ProductVariantPaginatedSearchRequest","kind":"json-schema","title":"ProductVariantPaginatedSearchRequest","data":{"allOf":[{"$ref":"#/components/schemas/BasePaginatedSearchInAccountRequest"},{"$ref":"#/components/schemas/BaseProductVariantSearchRequest"},{"$ref":"#/components/schemas/ProductVariantAggregationRequestsMap"}]}},"components/schemas/BaseProductVariantSearch":{"id":"components/schemas/BaseProductVariantSearch","kind":"json-schema","title":"BaseProductVariantSearch","data":{"type":"object","required":["results","totalResults"],"properties":{"results":{"type":"array","description":"The requested page of product variants which match the search criterion","items":{"$ref":"#/components/schemas/ProductVariantWithPermittedActions"}},"totalResults":{"type":"integer","description":"The total number of product variants which match the search criterion","example":1337}}}},"components/schemas/ProductVariantAggregationBucket":{"id":"components/schemas/ProductVariantAggregationBucket","kind":"json-schema","title":"ProductVariantAggregationBucket","data":{"type":"object","required":["key","count"],"properties":{"key":{"type":"string","description":"The unique name of the bucket","example":"Example bucket"},"count":{"type":"integer","description":"The number of product variants in the bucket","example":15}}}},"components/schemas/ProductVariantAggregationBucketResponse":{"id":"components/schemas/ProductVariantAggregationBucketResponse","kind":"json-schema","title":"ProductVariantAggregationBucketResponse","data":{"type":"object","required":["type","buckets"],"properties":{"type":{"type":"string"},"buckets":{"description":"The collection of unique buckets within the requested aggregation","type":"array","items":{"$ref":"#/components/schemas/ProductVariantAggregationBucket"}}}}},"components/schemas/ProductVariantAggregationResponse":{"id":"components/schemas/ProductVariantAggregationResponse","kind":"json-schema","title":"ProductVariantAggregationResponse","data":{"oneOf":[{"$ref":"#/components/schemas/ProductVariantAggregationBucketResponse"}],"discriminator":{"propertyName":"type","mapping":{"BUCKET":"#/components/schemas/ProductVariantAggregationBucketResponse"}}}},"components/schemas/ProductVariantAggregationResponsesMap":{"id":"components/schemas/ProductVariantAggregationResponsesMap","kind":"json-schema","title":"ProductVariantAggregationResponsesMap","data":{"type":"object","properties":{"aggregations":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ProductVariantAggregationResponse"},"description":"A map of the aggregations requested keyed on the keys provided by the user in the request."}}}},"components/schemas/ProductVariantSearch":{"id":"components/schemas/ProductVariantSearch","kind":"json-schema","title":"ProductVariantSearch","data":{"allOf":[{"$ref":"#/components/schemas/BaseProductVariantSearch"},{"$ref":"#/components/schemas/ProductVariantAggregationResponsesMap"},{"type":"object"}]}},"components/schemas/CorebookSettings":{"id":"components/schemas/CorebookSettings","kind":"json-schema","title":"CorebookSettings","data":{"type":"object","properties":{"accountId":{"description":"The ID of the account the Corebook settings belong to","type":"string","example":"cfb665ca-ce35-4418-b9d5-70ee815db4bd"},"enabled":{"description":"Whether Corebook integration is enable","type":"boolean","example":true},"corebookUrl":{"description":"The URL to Corebook that is used to link users to the brand guidelines","type":"string","example":"https://www.corebook.io/dash"}}}},"components/schemas/CorebookSettingsWithPermittedActions":{"id":"components/schemas/CorebookSettingsWithPermittedActions","kind":"json-schema","title":"CorebookSettingsWithPermittedActions","data":{"type":"object","required":["result","permittedActions"],"properties":{"result":{"$ref":"#/components/schemas/CorebookSettings"},"permittedActions":{"type":"array","items":{"$ref":"#/components/schemas/PermittedAction"}}}}},"components/schemas/CorebookSettingsRequest":{"id":"components/schemas/CorebookSettingsRequest","kind":"json-schema","title":"CorebookSettingsRequest","data":{"type":"object","properties":{"enabled":{"description":"Whether Corebook integration is enable","type":"boolean","example":true},"corebookUrl":{"description":"The URL to Corebook that will be used to link users to the brand guidelines","type":"string","example":"https://www.corebook.io/dash"}}}},"components/schemas/WordPressSettings":{"id":"components/schemas/WordPressSettings","kind":"json-schema","title":"WordPressSettings","data":{"type":"object","required":["accountId","clientId","clientSecret","baseUrls"],"properties":{"accountId":{"description":"The ID of the account of these WordPress settings.","type":"string","example":"cfb665ca-ce35-4418-b9d5-70ee815db4bd"},"clientId":{"description":"The ID of the client application. Used to configure the Dash WordPress plugin.","type":"string","example":"CFB665Cace354418B9D570EE815DB4bd"},"clientSecret":{"description":"The secret of the client application (not base64 encoded). Used to configure the Dash WordPress plugin.","type":"string","example":"EE815DB4-CFB665Ca-fzHDlUibM9g6JwiOXf9Vxh6f_egJD"},"baseUrls":{"description":"The base urls of your WordPress instances using the Dash plugin.","type":"array","items":{"description":"The base URL","type":"string","example":"https://my-wordpress.com"}}}}},"components/schemas/WordPressSettingsWithPermittedActions":{"id":"components/schemas/WordPressSettingsWithPermittedActions","kind":"json-schema","title":"WordPressSettingsWithPermittedActions","data":{"type":"object","required":["result","permittedActions"],"properties":{"result":{"$ref":"#/components/schemas/WordPressSettings"},"permittedActions":{"type":"array","items":{"$ref":"#/components/schemas/PermittedAction"}}}}},"components/schemas/WordPressSettingsPutRequest":{"id":"components/schemas/WordPressSettingsPutRequest","kind":"json-schema","title":"WordPressSettingsPutRequest","data":{"type":"object","required":["baseUrls"],"properties":{"baseUrls":{"description":"The base urls of your WordPress instances using the Dash plugin.","type":"array","items":{"description":"The base URL","type":"string","example":"https://my-wordpress.com"}}}}},"components/schemas/WordPressSettingsPatchRequest":{"id":"components/schemas/WordPressSettingsPatchRequest","kind":"json-schema","title":"WordPressSettingsPatchRequest","data":{"type":"object","properties":{"baseUrls":{"description":"The base urls of your WordPress instances using the Dash plugin.","type":"array","nullable":true,"items":{"description":"The base URL","type":"string","example":"https://my-wordpress.com"}}}}},"components/schemas/ShopifyExportResultAssetFailure":{"id":"components/schemas/ShopifyExportResultAssetFailure","kind":"json-schema","title":"ShopifyExportResultAssetFailure","data":{"type":"object","required":["assetId","assetFileId"],"properties":{"assetId":{"type":"string","example":"7af90a8b-7ccd-430f-a85d-e8614015bc47"},"assetFileId":{"type":"string","example":"7af90a8b-7ccd-430f-a85d-e8614015bc47"}}}},"components/schemas/ShopifyExportResultUploadFailure":{"id":"components/schemas/ShopifyExportResultUploadFailure","kind":"json-schema","title":"ShopifyExportResultUploadFailure","data":{"type":"object","required":["assetId","assetFileId","filename","shopifyFileId"],"properties":{"assetId":{"type":"string","example":"7af90a8b-7ccd-430f-a85d-e8614015bc47"},"assetFileId":{"type":"string","example":"7af90a8b-7ccd-430f-a85d-e8614015bc47"},"filename":{"type":"string","example":"hat.jpg"},"shopifyFileId":{"type":"string","nullable":true,"example":"hat_1.jpg"}}}},"components/schemas/ShopifyExportResultProductAssignmentFailure":{"id":"components/schemas/ShopifyExportResultProductAssignmentFailure","kind":"json-schema","title":"ShopifyExportResultProductAssignmentFailure","data":{"type":"object","required":["productId","shopifyFileId"],"properties":{"productId":{"type":"string","example":"7af90a8b-7ccd-430f-a85d-e8614015bc47"},"shopifyFileId":{"type":"string","example":"hat_1.jpg"}}}},"components/schemas/ShopifyExportResultProductRemovalFailure":{"id":"components/schemas/ShopifyExportResultProductRemovalFailure","kind":"json-schema","title":"ShopifyExportResultProductRemovalFailure","data":{"type":"object","required":["productId","shopifyFileId"],"properties":{"productId":{"type":"string","description":"The ID of the Shopify product from which the file could not be removed","example":"gid://shopify/Product/1234"},"shopifyFileId":{"type":"string","description":"The ID of the Shopify file that could not be removed from the product","example":"gid://shopify/MediaImage/5678"}}}},"components/schemas/ShopifyExportResultProductReorderFailure":{"id":"components/schemas/ShopifyExportResultProductReorderFailure","kind":"json-schema","title":"ShopifyExportResultProductReorderFailure","data":{"type":"object","required":["productId"],"properties":{"productId":{"type":"string","example":"7af90a8b-7ccd-430f-a85d-e8614015bc47"}}}},"components/schemas/ShopifyExportResult":{"id":"components/schemas/ShopifyExportResult","kind":"json-schema","title":"ShopifyExportResult","data":{"type":"object","required":["hasAnyFailures","transformationFailures","uploadFailures","productAssignmentFailures","productRemovalFailures","reorderFailures"],"properties":{"hasAnyFailures":{"type":"boolean","example":true},"transformationFailures":{"type":"array","items":{"$ref":"#/components/schemas/ShopifyExportResultAssetFailure"}},"uploadFailures":{"type":"array","items":{"$ref":"#/components/schemas/ShopifyExportResultUploadFailure"}},"productAssignmentFailures":{"type":"array","items":{"$ref":"#/components/schemas/ShopifyExportResultProductAssignmentFailure"}},"productRemovalFailures":{"type":"array","items":{"$ref":"#/components/schemas/ShopifyExportResultProductRemovalFailure"}},"reorderFailures":{"type":"array","items":{"$ref":"#/components/schemas/ShopifyExportResultProductReorderFailure"}}}}},"components/schemas/ShopifyExportCompletedJob":{"id":"components/schemas/ShopifyExportCompletedJob","kind":"json-schema","title":"ShopifyExportCompletedJob","data":{"allOf":[{"$ref":"#/components/schemas/CompletedJob"},{"type":"object","required":["result"],"properties":{"result":{"$ref":"#/components/schemas/ShopifyExportResult"}}}]}},"components/schemas/ShopifyExportJob":{"id":"components/schemas/ShopifyExportJob","kind":"json-schema","title":"ShopifyExportJob","data":{"oneOf":[{"$ref":"#/components/schemas/InProgressJob"},{"$ref":"#/components/schemas/ShopifyExportCompletedJob"},{"$ref":"#/components/schemas/FailedJob"}],"discriminator":{"propertyName":"type","mapping":{"IN_PROGRESS":"#/components/schemas/InProgressJob","COMPLETED":"#/components/schemas/ShopifyExportCompletedJob","FAILED":"#/components/schemas/FailedJob"}}}},"components/schemas/ShopifyExportJobWithPermittedActions":{"id":"components/schemas/ShopifyExportJobWithPermittedActions","kind":"json-schema","title":"ShopifyExportJobWithPermittedActions","data":{"type":"object","required":["result","permittedActions"],"properties":{"result":{"$ref":"#/components/schemas/ShopifyExportJob"},"permittedActions":{"type":"array","items":{"$ref":"#/components/schemas/PermittedAction"}}}}},"components/schemas/ShopifyFile":{"id":"components/schemas/ShopifyFile","kind":"json-schema","title":"ShopifyFile","data":{"type":"object","required":["type","shopifyFileId"],"properties":{"type":{"type":"string","enum":["SHOPIFY_FILE"]},"shopifyFileId":{"type":"string","description":"The ID of the file in shopify to update the position of","example":"7af90a8b-7ccd-430f-a85d-e8614015bc47"}}}},"components/schemas/DashAsset":{"id":"components/schemas/DashAsset","kind":"json-schema","title":"DashAsset","data":{"type":"object","required":["type","assetId","assetFileId","transformationDescription"],"properties":{"type":{"type":"string","enum":["ASSET"]},"assetId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to export to Shopify"},"children":[]}]}]}],"example":"7af90a8b-7ccd-430f-a85d-e8614015bc47"},"assetFileId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/getassetfiles"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetFile"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to export to Shopify"},"children":[]}]}]}],"example":"7af90a8b-7ccd-430f-a85d-e8614015bc47"},"transformationDescription":{"$ref":"#/components/schemas/TransformationDescription"},"presetParameters":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PresetParameters for this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"assetId"},"children":[]}]}]}],"default":[],"items":{"$ref":"#/components/schemas/PresetParameters"}}}}},"components/schemas/ShopifyExportSource":{"id":"components/schemas/ShopifyExportSource","kind":"json-schema","title":"ShopifyExportSource","data":{"oneOf":[{"$ref":"#/components/schemas/ShopifyFile"},{"$ref":"#/components/schemas/DashAsset"}],"discriminator":{"propertyName":"type","mapping":{"SHOPIFY_FILE":"#/components/schemas/ShopifyFile","ASSET":"#/components/schemas/DashAsset"}}}},"components/schemas/ShopifyProductFileDestination":{"id":"components/schemas/ShopifyProductFileDestination","kind":"json-schema","title":"ShopifyProductFileDestination","data":{"type":"object","required":["productId","position"],"properties":{"productId":{"description":"The id of the product in Shopify to create images for","type":"string","example":1234},"position":{"type":"integer","description":"The position of the Shopify image in the product listing","example":3}}}},"components/schemas/ShopifyExportUploadItem":{"id":"components/schemas/ShopifyExportUploadItem","kind":"json-schema","title":"ShopifyExportUploadItem","data":{"type":"object","required":["source","productFileDestinations"],"properties":{"type":{"type":"string","enum":["UPLOAD"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Item type discriminator. May be omitted for backwards compatibility — the backend defaults to UPLOAD when the field is absent."},"children":[]}]}]}]},"source":{"$ref":"#/components/schemas/ShopifyExportSource"},"productFileDestinations":{"type":"array","items":{"$ref":"#/components/schemas/ShopifyProductFileDestination"}}}}},"components/schemas/ShopifyExportRemovalItem":{"id":"components/schemas/ShopifyExportRemovalItem","kind":"json-schema","title":"ShopifyExportRemovalItem","data":{"type":"object","required":["type","productId","shopifyFileId"],"properties":{"type":{"type":"string","enum":["REMOVAL"]},"productId":{"type":"string","description":"The ID of the product in Shopify to detach the file from","example":"gid://shopify/Product/1234"},"shopifyFileId":{"type":"string","description":"The ID of the Shopify file to detach from the product","example":"gid://shopify/MediaImage/5678"}}}},"components/schemas/ShopifyExportRequestItem":{"id":"components/schemas/ShopifyExportRequestItem","kind":"json-schema","title":"ShopifyExportRequestItem","data":{"oneOf":[{"$ref":"#/components/schemas/ShopifyExportUploadItem"},{"$ref":"#/components/schemas/ShopifyExportRemovalItem"}],"discriminator":{"propertyName":"type","mapping":{"UPLOAD":"#/components/schemas/ShopifyExportUploadItem","REMOVAL":"#/components/schemas/ShopifyExportRemovalItem"}}}},"components/schemas/ShopifyExportRequest":{"id":"components/schemas/ShopifyExportRequest","kind":"json-schema","title":"ShopifyExportRequest","data":{"type":"object","required":["shop","shopifyAccessToken","items"],"properties":{"shop":{"type":"string","description":"The shop to search within","example":"planto.myshopify.com"},"shopifyAccessToken":{"type":"string","description":"An access token obtained for the above Shopify store that will be used to make requests to Shopify with","example":"cjuqb_6bp89123d45516c78288f433bd8bc13j"},"items":{"type":"array","items":{"$ref":"#/components/schemas/ShopifyExportRequestItem"}}}}},"components/schemas/CreateShopifyProductImageBatchRequest":{"id":"components/schemas/CreateShopifyProductImageBatchRequest","kind":"json-schema","title":"CreateShopifyProductImageBatchRequest","data":{"type":"object","required":["productId","items","transformationDescription"],"properties":{"shop":{"description":"The \"shop\" slug for the specific Shopify shop to create images in","type":"string","example":"example.myshopify.com"},"productId":{"description":"The id of the product in Shopify to create images for","type":"string","example":1234},"items":{"type":"array","items":{"$ref":"#/components/schemas/AssetDownloadBatchRequestItem"}},"transformationDescription":{"$ref":"#/components/schemas/TransformationDescription"}}}},"components/schemas/ShopifyImageUsedInProduct":{"id":"components/schemas/ShopifyImageUsedInProduct","kind":"json-schema","title":"ShopifyImageUsedInProduct","data":{"type":"object","required":["type","productId"],"properties":{"type":{"type":"string","enum":["PRODUCT"]},"productId":{"description":"The id of the product in Shopify to create images for","type":"string","example":1234}}}},"components/schemas/ShopifyImageUsedInOther":{"id":"components/schemas/ShopifyImageUsedInOther","kind":"json-schema","title":"ShopifyImageUsedInOther","data":{"type":"object","required":["type","sourcePage"],"properties":{"type":{"type":"string","enum":["OTHER"]},"sourcePage":{"enum":["ARTICLE","BLOG","PAGE"]}}}},"components/schemas/ShopifyImageUsedIn":{"id":"components/schemas/ShopifyImageUsedIn","kind":"json-schema","title":"ShopifyImageUsedIn","data":{"oneOf":[{"$ref":"#/components/schemas/ShopifyImageUsedInProduct"},{"$ref":"#/components/schemas/ShopifyImageUsedInOther"}],"discriminator":{"propertyName":"type","mapping":{"PRODUCT":"#/components/schemas/ShopifyImageUsedInProduct","OTHER":"#/components/schemas/ShopifyImageUsedInOther"}}}},"components/schemas/CreateShopifyImageBatchRequest":{"id":"components/schemas/CreateShopifyImageBatchRequest","kind":"json-schema","title":"CreateShopifyImageBatchRequest","data":{"type":"object","required":["usedIn","items","transformationDescription"],"properties":{"shop":{"description":"The \"shop\" slug for the specific Shopify shop to create images in","type":"string","example":"example.myshopify.com"},"usedIn":{"$ref":"#/components/schemas/ShopifyImageUsedIn"},"items":{"type":"array","items":{"$ref":"#/components/schemas/AssetDownloadBatchRequestItem"}},"transformationDescription":{"$ref":"#/components/schemas/TransformationDescription"}}}},"components/schemas/ShopifyProductSyncStatus":{"id":"components/schemas/ShopifyProductSyncStatus","kind":"json-schema","title":"ShopifyProductSyncStatus","data":{"type":"object","required":["inProgress"],"properties":{"inProgress":{"description":"Whether a Shopify product sync is currently in progress for the account","type":"boolean","example":false},"lastCompletedAt":{"description":"When a Shopify product sync last completed for the account, if ever","type":"string","format":"date-time","nullable":true,"example":"2026-06-22T00:00:00Z"}}}},"components/schemas/ShopifyProductSyncStatusWithPermittedActions":{"id":"components/schemas/ShopifyProductSyncStatusWithPermittedActions","kind":"json-schema","title":"ShopifyProductSyncStatusWithPermittedActions","data":{"type":"object","required":["result","permittedActions"],"properties":{"result":{"$ref":"#/components/schemas/ShopifyProductSyncStatus"},"permittedActions":{"type":"array","items":{"$ref":"#/components/schemas/PermittedAction"}}}}},"components/schemas/ShopifyProductSyncSettings":{"id":"components/schemas/ShopifyProductSyncSettings","kind":"json-schema","title":"ShopifyProductSyncSettings","data":{"type":"object","required":["shopifyDomains"],"properties":{"shopifyDomains":{"description":"The Shopify store domains used for product syncs. Only an empty list (no connection configured)\nor a single connection is supported.\n","type":"array","items":{"description":"The domain of the Shopify store","type":"string","example":"slurm.myshopify.com"}}}}},"components/schemas/ShopifyProductSyncSettingsWithPermittedActions":{"id":"components/schemas/ShopifyProductSyncSettingsWithPermittedActions","kind":"json-schema","title":"ShopifyProductSyncSettingsWithPermittedActions","data":{"type":"object","required":["result","permittedActions"],"properties":{"result":{"$ref":"#/components/schemas/ShopifyProductSyncSettings"},"permittedActions":{"type":"array","items":{"$ref":"#/components/schemas/PermittedAction"}}}}},"components/schemas/ShopifyProductSyncSettingsRequest":{"id":"components/schemas/ShopifyProductSyncSettingsRequest","kind":"json-schema","title":"ShopifyProductSyncSettingsRequest","data":{"type":"object","required":["shopifyDomains"],"properties":{"shopifyDomains":{"description":"The full list of Shopify store domains to use for product syncs. Only an empty list (clear the\nconfigured connection) or a single connection is supported; more than one is rejected.\n","type":"array","items":{"description":"The domain of the Shopify store","type":"string","example":"slurm.myshopify.com"}}}}},"components/schemas/CustomIntegrationSettings":{"id":"components/schemas/CustomIntegrationSettings","kind":"json-schema","title":"CustomIntegrationSettings","data":{"type":"object","required":["accountId","clientId","clientSecret","allowedWebOriginUrls","allowedCallbackUrls","allowedLogoutUrls"],"properties":{"accountId":{"description":"The ID of the account the WordPress settings belong to","type":"string","example":"cfb665ca-ce35-4418-b9d5-70ee815db4bd"},"clientId":{"description":"The ID of the client application. Used in the authentication flow of your custom integartion.","type":"string","example":"CFB665Cace354418B9D570EE815DB4bd"},"clientSecret":{"description":"The secret of the client application. Used in the authentication flow of your custom integartion.","type":"string","example":"EE815DB4-CFB665Ca-fzHDlUibM9g6JwiOXf9Vxh6f_egJD"},"allowedWebOriginUrls":{"description":"Allowed origins for use in any cross-origin authentication flow","type":"array","items":{"description":"The allowed origin URL","type":"string","example":"https://my-app.com"}},"allowedCallbackUrls":{"description":"Allowed URLs for callback during authentication flow","type":"array","items":{"description":"The allowed callback URL","type":"string","example":"https://my-app.com/callback"}},"allowedLogoutUrls":{"description":"Allowed URLs to redirect to after logout","type":"array","items":{"description":"The allowed callback URL","type":"string","example":"https://my-app.com/callback"}}}}},"components/schemas/CustomIntegrationSettingsWithPermittedActions":{"id":"components/schemas/CustomIntegrationSettingsWithPermittedActions","kind":"json-schema","title":"CustomIntegrationSettingsWithPermittedActions","data":{"type":"object","required":["result","permittedActions"],"properties":{"result":{"$ref":"#/components/schemas/CustomIntegrationSettings"},"permittedActions":{"type":"array","items":{"$ref":"#/components/schemas/PermittedAction"}}}}},"components/schemas/CustomIntegrationSettingsPutRequest":{"id":"components/schemas/CustomIntegrationSettingsPutRequest","kind":"json-schema","title":"CustomIntegrationSettingsPutRequest","data":{"type":"object","required":["allowedWebOriginUrls","allowedCallbackUrls","allowedLogoutUrls"],"properties":{"allowedWebOriginUrls":{"description":"Allowed origins for use in the cross-origin authentication flow","type":"array","items":{"description":"The allowed origin URL","type":"string","example":"https://my-app.com"}},"allowedCallbackUrls":{"description":"Allowed URLs for callback (i.e. with generated access token) during authentication flow","type":"array","items":{"description":"The allowed callback URL","type":"string","example":"https://my-app.com/callback"}},"allowedLogoutUrls":{"description":"Allowed URLs to redirect to after logout","type":"array","items":{"description":"The allowed callback URL","type":"string","example":"https://my-app.com/callback"}}}}},"components/schemas/CustomIntegrationSettingsPatchRequest":{"id":"components/schemas/CustomIntegrationSettingsPatchRequest","kind":"json-schema","title":"CustomIntegrationSettingsPatchRequest","data":{"type":"object","properties":{"allowedWebOriginUrls":{"description":"Allowed origins for use in the cross-origin authentication flow","type":"array","nullable":true,"items":{"description":"The allowed origin URL","type":"string","example":"https://my-app.com"}},"allowedCallbackUrls":{"description":"Allowed URLs for callback (i.e. with generated access token) during authentication flow","type":"array","nullable":true,"items":{"description":"The allowed callback URL","type":"string","example":"https://my-app.com/callback"}},"allowedLogoutUrls":{"description":"Allowed URLs to redirect to after logout","type":"array","nullable":true,"items":{"description":"The allowed callback URL","type":"string","example":"https://my-app.com/callback"}}}}},"components/schemas/ExternalAppUserRequest":{"id":"components/schemas/ExternalAppUserRequest","kind":"json-schema","title":"ExternalAppUserRequest","data":{"type":"object","properties":{"externalAppUserId":{"type":"string","description":"External app user ID"},"appName":{"type":"string","enum":["CANVA"]}}}},"components/schemas/ExternalAppSsoTokenRequest":{"id":"components/schemas/ExternalAppSsoTokenRequest","kind":"json-schema","title":"ExternalAppSsoTokenRequest","data":{"type":"object","required":["appName"],"properties":{"appName":{"type":"string","enum":["FRILL","PRODUCTBOARD"]}}}},"components/schemas/AppName":{"id":"components/schemas/AppName","kind":"json-schema","title":"AppName","data":{"type":"string","enum":["SHOPIFY"],"example":"SHOPIFY"}},"components/schemas/ExternalAppAccount":{"id":"components/schemas/ExternalAppAccount","kind":"json-schema","title":"ExternalAppAccount","data":{"type":"object","required":["id","accountId","externalAppAccountId","appName","configured"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/external-app/getexternalappaccounts"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ExternalAppAccount"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource."},"children":[]}]}]}],"example":"55f9964c-095d-4b8b-bb5e-4118d2e76ad0"},"accountId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/external-app/getexternalappaccounts"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ExternalAppAccount"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" belongs to"},"children":[]}]}]}],"type":"string","example":"cfb665ca-ce35-4418-b9d5-70ee815db4bd"},"externalAppAccountId":{"type":"string","description":"A unique identifier of the specific account to connect to in the external app","example":"my.myshopify.com"},"appName":{"$ref":"#/components/schemas/AppName"},"configured":{"type":"boolean","description":"Whether the external app has been configured and is ready for use. e.g. has the Dash Shopify app been successfully installed in your store","example":true}}}},"components/schemas/ExternalAppAccountWithPermittedActions":{"id":"components/schemas/ExternalAppAccountWithPermittedActions","kind":"json-schema","title":"ExternalAppAccountWithPermittedActions","data":{"type":"object","required":["result","permittedActions"],"properties":{"result":{"$ref":"#/components/schemas/ExternalAppAccount"},"permittedActions":{"type":"array","items":{"$ref":"#/components/schemas/PermittedAction"}}}}},"components/schemas/ExternalAppAccountRequest":{"id":"components/schemas/ExternalAppAccountRequest","kind":"json-schema","title":"ExternalAppAccountRequest","data":{"type":"object","required":["externalAppAccountId","appName","connectionPayload"],"properties":{"externalAppAccountId":{"type":"string","description":"A unique identifier of the specific account to connect to in the external app","example":"put the Shopify domain here"},"appName":{"$ref":"#/components/schemas/AppName"},"connectionPayload":{"type":"object","description":"Any additional data that is required to connect to the external app","example":"{\n  \"type\": \"SHOPIFY\",\n  \"clientId\": \"put the Client ID here\",\n  \"clientSecret\": \"put the Client secret here\",\n  \"accessToken\": \"\"\n}\n"}}}},"components/schemas/CollectionShareRequest":{"id":"components/schemas/CollectionShareRequest","kind":"json-schema","title":"CollectionShareRequest","data":{"type":"object","required":["collectionId"],"properties":{"collectionId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Collections"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Collection"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to be shared"},"children":[]}]}]}],"type":"string","example":"a52b5315-15b8-417f-b742-d6902108bac1"},"expiry":{"type":"string","nullable":true,"format":"date-time","description":"The datetime the share will expire and no longer be accessible in ISO datetime format. If the expiry is null, the share will never expire.","example":"2021-02-17T09:24:01.417Z","default":null},"assetPermittedActions":{"$ref":"#/components/schemas/AssetPermittedActionsWithDefault"}}}},"components/schemas/CollectionShareWithPermittedActions":{"id":"components/schemas/CollectionShareWithPermittedActions","kind":"json-schema","title":"CollectionShareWithPermittedActions","data":{"type":"object","required":["result","permittedActions"],"properties":{"result":{"$ref":"#/components/schemas/CollectionShare"},"permittedActions":{"type":"array","items":{"$ref":"#/components/schemas/PermittedAction"}}}}},"components/schemas/CollectionSharePatchRequest":{"id":"components/schemas/CollectionSharePatchRequest","kind":"json-schema","title":"CollectionSharePatchRequest","data":{"type":"object","properties":{"expiry":{"$ref":"#/components/schemas/NullableDateTimePatch"},"assetPermittedActions":{"$ref":"#/components/schemas/AssetPermittedActions"}}}},"components/schemas/CollectionShareSearchField":{"id":"components/schemas/CollectionShareSearchField","kind":"json-schema","title":"CollectionShareSearchField","data":{"type":"string","enum":["CREATED_BY"],"example":"CREATED_BY","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Users"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" who created the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Collection-Shares"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CollectionShare"},"children":[]}]}]}]}]}},"components/schemas/CollectionShareFieldEqualsSearchCriterion":{"id":"components/schemas/CollectionShareFieldEqualsSearchCriterion","kind":"json-schema","title":"CollectionShareFieldEqualsSearchCriterion","data":{"allOf":[{"$ref":"#/components/schemas/FieldEqualsSearchCriterion"},{"type":"object","required":["type","field"],"properties":{"type":{"type":"string","enum":["FIELD_EQUALS"],"example":"FIELD_EQUALS"},"field":{"$ref":"#/components/schemas/CollectionShareSearchField"}}}]}},"components/schemas/CollectionShareSearchCriterion":{"id":"components/schemas/CollectionShareSearchCriterion","kind":"json-schema","title":"CollectionShareSearchCriterion","data":{"oneOf":[{"$ref":"#/components/schemas/CollectionShareFieldEqualsSearchCriterion"}],"discriminator":{"propertyName":"type","mapping":{"FIELD_EQUALS":"#/components/schemas/CollectionShareFieldEqualsSearchCriterion"}}}},"components/schemas/CollectionShareSortField":{"id":"components/schemas/CollectionShareSortField","kind":"json-schema","title":"CollectionShareSortField","data":{"type":"string","enum":["ID","COLLECTION_ID","EXPIRY"],"example":"ID","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Collection-Shares"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CollectionShare"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property value"},"children":[]}]}]}]}},"components/schemas/CollectionShareSort":{"id":"components/schemas/CollectionShareSort","kind":"json-schema","title":"CollectionShareSort","data":{"type":"object","properties":{"field":{"$ref":"#/components/schemas/CollectionShareSortField"},"order":{"$ref":"#/components/schemas/SortOrder"}}}},"components/schemas/CollectionShareSearchRequest":{"id":"components/schemas/CollectionShareSearchRequest","kind":"json-schema","title":"CollectionShareSearchRequest","data":{"allOf":[{"$ref":"#/components/schemas/BasePaginatedSearchInAccountRequest"},{"type":"object","properties":{"criterion":{"description":"The search criterion","$ref":"#/components/schemas/CollectionShareSearchCriterion"},"sorts":{"description":"Sorts to be applied to the search in order of precedence","type":"array","items":{"$ref":"#/components/schemas/CollectionShareSort"}}}}]}},"components/schemas/CollectionShareSearch":{"id":"components/schemas/CollectionShareSearch","kind":"json-schema","title":"CollectionShareSearch","data":{"type":"object","properties":{"results":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The specified page of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Collection-Shares"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CollectionShare"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources which match the search criterion"},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/CollectionShareWithPermittedActions"}},"totalResults":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total number of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Collection-Shares"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CollectionShare"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources which match the search criterion"},"children":[]}]}]}],"example":15}}}},"components/schemas/FieldHasItemSearchCriterion":{"id":"components/schemas/FieldHasItemSearchCriterion","kind":"json-schema","title":"FieldHasItemSearchCriterion","data":{"allOf":[{"$ref":"#/components/schemas/SearchCriterion"},{"type":"object","required":["value"],"properties":{"value":{"type":"string","description":"Checks whether a collection field has an item of exactly this value","example":"an item"}}}]}},"components/schemas/PublicCollectionShareSearchField":{"id":"components/schemas/PublicCollectionShareSearchField","kind":"json-schema","title":"PublicCollectionShareSearchField","data":{"type":"string","enum":["SLUGS"],"example":"SLUGS","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Collection-Shares"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PublicCollectionShare"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property value"},"children":[]}]}]}]}},"components/schemas/PublicCollectionShareFieldHasItemSearchCriterion":{"id":"components/schemas/PublicCollectionShareFieldHasItemSearchCriterion","kind":"json-schema","title":"PublicCollectionShareFieldHasItemSearchCriterion","data":{"allOf":[{"$ref":"#/components/schemas/FieldHasItemSearchCriterion"},{"type":"object","properties":{"field":{"$ref":"#/components/schemas/PublicCollectionShareSearchField"}}}]}},"components/schemas/PublicCollectionShareSearchCriterion":{"id":"components/schemas/PublicCollectionShareSearchCriterion","kind":"json-schema","title":"PublicCollectionShareSearchCriterion","data":{"oneOf":[{"$ref":"#/components/schemas/PublicCollectionShareFieldHasItemSearchCriterion"}],"discriminator":{"propertyName":"type","mapping":{"FIELD_HAS_ITEMS":"#/components/schemas/PublicCollectionShareFieldHasItemSearchCriterion"}}}},"components/schemas/PublicCollectionShareSortField":{"id":"components/schemas/PublicCollectionShareSortField","kind":"json-schema","title":"PublicCollectionShareSortField","data":{"type":"string","enum":["ID"],"example":"ID","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Collection-Shares"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PublicCollectionShare"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property value"},"children":[]}]}]}]}},"components/schemas/PublicCollectionShareSort":{"id":"components/schemas/PublicCollectionShareSort","kind":"json-schema","title":"PublicCollectionShareSort","data":{"type":"object","properties":{"field":{"$ref":"#/components/schemas/PublicCollectionShareSortField"},"order":{"$ref":"#/components/schemas/SortOrder"}}}},"components/schemas/PublicCollectionShareSearchRequest":{"id":"components/schemas/PublicCollectionShareSearchRequest","kind":"json-schema","title":"PublicCollectionShareSearchRequest","data":{"allOf":[{"$ref":"#/components/schemas/BasePaginatedSearchInAccountRequest"},{"type":"object","properties":{"criterion":{"description":"The search criterion","$ref":"#/components/schemas/PublicCollectionShareSearchCriterion"},"sorts":{"description":"Sorts to be applied to the search in order of precedence","type":"array","items":{"$ref":"#/components/schemas/PublicCollectionShareSort"}}}}]}},"components/schemas/SavedSearchRequest":{"id":"components/schemas/SavedSearchRequest","kind":"json-schema","title":"SavedSearchRequest","data":{"type":"object","required":["name","emailUserOnNewUploads","criterion","sorts"],"properties":{"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Saved-Searches"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SavedSearch"},"children":[]}]}]}]}],"example":"My favourite search"},"emailUserOnNewUploads":{"description":"Whether to email the creator when a new upload matches the saved search criterion","type":"boolean","example":true},"criterion":{"description":"The search criterion","$ref":"#/components/schemas/AssetSearchCriterion"},"sorts":{"description":"Sorts to be applied to the search in order of precedence","type":"array","items":{"$ref":"#/components/schemas/AssetSort"}}}}},"components/schemas/SavedSearch":{"id":"components/schemas/SavedSearch","kind":"json-schema","title":"SavedSearch","data":{"type":"object","required":["id","accountId","name","creatorId","emailUserOnNewUploads","criterion","sorts"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Saved-Searches"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SavedSearch"},"children":[]}]}]}]}],"example":"1627573b-1273-441e-90d1-505d1f8ab47c"},"accountId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Saved-Searches"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SavedSearch"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" belongs to"},"children":[]}]}]}],"type":"string","example":"cfb665ca-ce35-4418-b9d5-70ee815db4bd"},"creatorId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Users"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" who created the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Saved-Searches"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SavedSearch"},"children":[]}]}]}]}],"type":"string","example":"google-oauth2|110955770826801837334"},"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Saved-Searches"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SavedSearch"},"children":[]}]}]}]}],"example":"My favourite search"},"emailUserOnNewUploads":{"description":"Whether to email the creator when a new upload matches the saved search criterion","type":"boolean","example":true},"criterion":{"description":"The search criterion","$ref":"#/components/schemas/AssetSearchCriterion"},"sorts":{"description":"Sorts to be applied to the search in order of precedence","type":"array","items":{"$ref":"#/components/schemas/AssetSort"}}}}},"components/schemas/SavedSearchWithPermittedActions":{"id":"components/schemas/SavedSearchWithPermittedActions","kind":"json-schema","title":"SavedSearchWithPermittedActions","data":{"type":"object","required":["result","permittedActions"],"properties":{"result":{"$ref":"#/components/schemas/SavedSearch"},"permittedActions":{"type":"array","items":{"$ref":"#/components/schemas/PermittedAction"}}}}},"components/schemas/SavedSearchPatchRequest":{"id":"components/schemas/SavedSearchPatchRequest","kind":"json-schema","title":"SavedSearchPatchRequest","data":{"type":"object","properties":{"name":{"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":"Name of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Saved-Searches"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SavedSearch"},"children":[]}]}]}]}],"example":"My favourite search"},"emailUserOnNewUploads":{"description":"Whether to email the creator when a new upload matches the saved search criterion","type":"boolean","nullable":true,"example":true}}}},"components/schemas/SavedSearchSearchField":{"id":"components/schemas/SavedSearchSearchField","kind":"json-schema","title":"SavedSearchSearchField","data":{"type":"string","enum":["CREATOR_ID"],"example":"CREATOR_ID","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Saved-Searches"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SavedSearch"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property value"},"children":[]}]}]}]}},"components/schemas/SavedSearchFieldEqualsSearchCriterion":{"id":"components/schemas/SavedSearchFieldEqualsSearchCriterion","kind":"json-schema","title":"SavedSearchFieldEqualsSearchCriterion","data":{"allOf":[{"$ref":"#/components/schemas/FieldEqualsSearchCriterion"},{"type":"object","required":["type","field"],"properties":{"type":{"type":"string","enum":["FIELD_EQUALS"]},"field":{"$ref":"#/components/schemas/SavedSearchSearchField"}}}]}},"components/schemas/SavedSearchSearchCriterion":{"id":"components/schemas/SavedSearchSearchCriterion","kind":"json-schema","title":"SavedSearchSearchCriterion","data":{"oneOf":[{"$ref":"#/components/schemas/SavedSearchFieldEqualsSearchCriterion"}],"discriminator":{"propertyName":"type","mapping":{"FIELD_EQUALS":"#/components/schemas/SavedSearchFieldEqualsSearchCriterion"}}}},"components/schemas/SavedSearchSearchRequest":{"id":"components/schemas/SavedSearchSearchRequest","kind":"json-schema","title":"SavedSearchSearchRequest","data":{"allOf":[{"$ref":"#/components/schemas/BasePaginatedSearchInAccountRequest"},{"type":"object","required":["criterion","sorts"],"properties":{"criterion":{"description":"The search criterion","$ref":"#/components/schemas/SavedSearchSearchCriterion"},"sorts":{"description":"This search does not accept any sorts, but has the sorts parameter anyway to fit in with other searches.  You must always provide an empty list for this parameter.","type":"array","items":{"type":"object"},"example":[]}}}]}},"components/schemas/SavedSearchSearch":{"id":"components/schemas/SavedSearchSearch","kind":"json-schema","title":"SavedSearchSearch","data":{"type":"object","required":["results","totalResults"],"properties":{"results":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The specified page of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Saved-Searches"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SavedSearch"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources which match the search criterion"},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/SavedSearchWithPermittedActions"}},"totalResults":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total number of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Saved-Searches"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SavedSearch"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources which match the search criterion"},"children":[]}]}]}],"example":15}}}},"components/schemas/AssetDownloadEventField":{"id":"components/schemas/AssetDownloadEventField","kind":"json-schema","title":"AssetDownloadEventField","data":{"type":"string","enum":["ASSET_ID","ASSET_FILE_ID","USER_EMAIL","USER_TYPE","DOWNLOAD_TYPE","DOWNLOAD_DESCRIPTION","DOWNLOAD_PRESET_ID","USER_ID","DATE_TIME","PORTAL_ID"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the ["},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetDownloadEvent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"] property value"},"children":[]}]}]}],"example":"ASSET_ID"}},"components/schemas/AssetDownloadEventFieldEqualsSearchCriterion":{"id":"components/schemas/AssetDownloadEventFieldEqualsSearchCriterion","kind":"json-schema","title":"AssetDownloadEventFieldEqualsSearchCriterion","data":{"allOf":[{"$ref":"#/components/schemas/FieldEqualsSearchCriterion"},{"type":"object","required":["field"],"properties":{"field":{"$ref":"#/components/schemas/AssetDownloadEventField"}}}]}},"components/schemas/FieldInRangeSearchCriterion":{"id":"components/schemas/FieldInRangeSearchCriterion","kind":"json-schema","title":"FieldInRangeSearchCriterion","data":{"allOf":[{"$ref":"#/components/schemas/SearchCriterion"},{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","description":"The value the range is from","example":"A"},"to":{"type":"string","description":"The value the range is to","example":"Z"}}}]}},"components/schemas/AssetDownloadEventFieldInRangeSearchCriterion":{"id":"components/schemas/AssetDownloadEventFieldInRangeSearchCriterion","kind":"json-schema","title":"AssetDownloadEventFieldInRangeSearchCriterion","data":{"allOf":[{"$ref":"#/components/schemas/FieldInRangeSearchCriterion"},{"type":"object","required":["field"],"properties":{"field":{"$ref":"#/components/schemas/AssetDownloadEventField"}}}]}},"components/schemas/AssetDownloadEventSearchCriterion":{"id":"components/schemas/AssetDownloadEventSearchCriterion","kind":"json-schema","title":"AssetDownloadEventSearchCriterion","data":{"oneOf":[{"$ref":"#/components/schemas/MatchAllSearchCriterion"},{"$ref":"#/components/schemas/AssetDownloadEventFieldEqualsSearchCriterion"},{"$ref":"#/components/schemas/AssetDownloadEventFieldInRangeSearchCriterion"},{"$ref":"#/components/schemas/AssetDownloadEventAndSearchCriterion"},{"$ref":"#/components/schemas/AssetDownloadEventOrSearchCriterion"},{"$ref":"#/components/schemas/AssetDownloadEventNotSearchCriterion"}],"discriminator":{"propertyName":"type","mapping":{"MATCH_ALL":"#/components/schemas/MatchAllSearchCriterion","FIELD_EQUALS":"#/components/schemas/AssetDownloadEventFieldEqualsSearchCriterion","FIELD_IN_RANGE":"#/components/schemas/AssetDownloadEventFieldInRangeSearchCriterion","AND":"#/components/schemas/AssetDownloadEventAndSearchCriterion","OR":"#/components/schemas/AssetDownloadEventOrSearchCriterion","NOT":"#/components/schemas/AssetDownloadEventNotSearchCriterion"}}}},"components/schemas/AssetDownloadEventAndSearchCriterion":{"id":"components/schemas/AssetDownloadEventAndSearchCriterion","kind":"json-schema","title":"AssetDownloadEventAndSearchCriterion","data":{"allOf":[{"$ref":"#/components/schemas/SearchCriterion"},{"type":"object","required":["criteria"],"properties":{"criteria":{"type":"array","items":{"$ref":"#/components/schemas/AssetDownloadEventSearchCriterion"},"description":"The list of criteria to AND together"}}}]}},"components/schemas/AssetDownloadEventOrSearchCriterion":{"id":"components/schemas/AssetDownloadEventOrSearchCriterion","kind":"json-schema","title":"AssetDownloadEventOrSearchCriterion","data":{"allOf":[{"$ref":"#/components/schemas/SearchCriterion"},{"type":"object","required":["criteria"],"properties":{"criteria":{"type":"array","description":"The list of criteria to OR together","items":{"$ref":"#/components/schemas/AssetDownloadEventSearchCriterion"}}}}]}},"components/schemas/AssetDownloadEventNotSearchCriterion":{"id":"components/schemas/AssetDownloadEventNotSearchCriterion","kind":"json-schema","title":"AssetDownloadEventNotSearchCriterion","data":{"allOf":[{"$ref":"#/components/schemas/SearchCriterion"},{"type":"object","required":["criterion"],"properties":{"criterion":{"description":"The criterion to negate","$ref":"#/components/schemas/AssetDownloadEventSearchCriterion","required":true}}}]}},"components/schemas/AssetDownloadEventSort":{"id":"components/schemas/AssetDownloadEventSort","kind":"json-schema","title":"AssetDownloadEventSort","data":{"type":"object","required":["field","order"],"properties":{"field":{"$ref":"#/components/schemas/AssetDownloadEventField"},"order":{"$ref":"#/components/schemas/SortOrder"}}}},"components/schemas/EventTermsAggregationRequest":{"id":"components/schemas/EventTermsAggregationRequest","kind":"json-schema","title":"EventTermsAggregationRequest","data":{"type":"object","required":["type"],"properties":{"type":{"type":"string"},"valueWhenMissing":{"type":"string","description":"The value to assign to events that do not have a value for the field that you are aggregating upon","example":"Unknown"}}}},"components/schemas/AssetDownloadEventTermsAggregationRequest":{"id":"components/schemas/AssetDownloadEventTermsAggregationRequest","kind":"json-schema","title":"AssetDownloadEventTermsAggregationRequest","data":{"allOf":[{"$ref":"#/components/schemas/EventTermsAggregationRequest"},{"type":"object","required":["field"],"properties":{"field":{"$ref":"#/components/schemas/AssetDownloadEventField","required":true}}}]}},"components/schemas/EventDateInterval":{"id":"components/schemas/EventDateInterval","kind":"json-schema","title":"EventDateInterval","data":{"type":"string","enum":["ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"description":"The interval to use for the date aggrgation","example":"ONE_HOUR"}},"components/schemas/EventDateHistogramAggregationRequest":{"id":"components/schemas/EventDateHistogramAggregationRequest","kind":"json-schema","title":"EventDateHistogramAggregationRequest","data":{"type":"object","required":["type","interval"],"properties":{"type":{"type":"string"},"interval":{"$ref":"#/components/schemas/EventDateInterval"},"valueWhenMissing":{"type":"string","description":"The value to assign to events that do not have a value for the field that you are aggregating upon","example":"Unknown"},"lowerBound":{"type":"string","format":"date-time","description":"Optional lower bound to use for the range of the date aggregation.\n\nIf excluded the first bucket returned will be the one containing the earliest event.\n\nIf included the empty buckets will be returned from the lower bound to bucket containing the earliest event.\n","example":"2021-02-15T09:24:01.417Z"},"upperBound":{"type":"string","format":"date-time","description":"Optional upper bound to use for the range of the date aggregation.\n\nIf excluded the last bucket returned will be the one containing the latest event.\n\nIf included the empty buckets will be returned from the bucket containing the latest event to the upper bound.\n","example":"2021-02-15T09:24:01.417Z"}}}},"components/schemas/AssetDownloadEventDateField":{"id":"components/schemas/AssetDownloadEventDateField","kind":"json-schema","title":"AssetDownloadEventDateField","data":{"type":"string","enum":["DATE_TIME"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the ["},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetDownloadEvent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"] date field"},"children":[]}]}]}],"example":"DATE_TIME"}},"components/schemas/AssetDownloadEventDateHistogramAggregationRequest":{"id":"components/schemas/AssetDownloadEventDateHistogramAggregationRequest","kind":"json-schema","title":"AssetDownloadEventDateHistogramAggregationRequest","data":{"allOf":[{"$ref":"#/components/schemas/EventDateHistogramAggregationRequest"},{"type":"object","required":["field"],"properties":{"field":{"$ref":"#/components/schemas/AssetDownloadEventDateField"}}}]}},"components/schemas/AssetDownloadEventAggregationRequest":{"id":"components/schemas/AssetDownloadEventAggregationRequest","kind":"json-schema","title":"AssetDownloadEventAggregationRequest","data":{"oneOf":[{"$ref":"#/components/schemas/AssetDownloadEventDateHistogramAggregationRequest"},{"$ref":"#/components/schemas/AssetDownloadEventTermsAggregationRequest"}],"discriminator":{"propertyName":"type","mapping":{"TERMS":"#/components/schemas/AssetDownloadEventTermsAggregationRequest","DATE_HISTOGRAM":"#/components/schemas/AssetDownloadEventDateHistogramAggregationRequest"}}}},"components/schemas/AssetDownloadEventSearchRequest":{"id":"components/schemas/AssetDownloadEventSearchRequest","kind":"json-schema","title":"AssetDownloadEventSearchRequest","data":{"allOf":[{"$ref":"#/components/schemas/BasePaginatedSearchInAccountRequest"},{"type":"object","required":["criterion","sorts"],"properties":{"criterion":{"$ref":"#/components/schemas/AssetDownloadEventSearchCriterion","description":"The search criterion","required":true},"sorts":{"type":"array","items":{"$ref":"#/components/schemas/AssetDownloadEventSort"},"description":"Sorts to be applied to the search in order of precedence","default":[]},"aggregations":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AssetDownloadEventAggregationRequest"},"description":"A map of requested aggregations. The results will be returned in a map with the same provided keys."}}}]}},"components/schemas/UserDataAccountUser":{"id":"components/schemas/UserDataAccountUser","kind":"json-schema","title":"UserDataAccountUser","data":{"type":"object","required":["type","userId","userEmail"],"properties":{"type":{"type":"string","enum":["ACCOUNT_USER"]},"userId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Users"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" who downloaded the asset"},"children":[]}]}]}],"example":"google-oauth2|110955770826801837334"},"userEmail":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The email address of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Users"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" who downloaded the asset"},"children":[]}]}]}],"example":"john.smith"}}}},"components/schemas/UserDataShareUser":{"id":"components/schemas/UserDataShareUser","kind":"json-schema","title":"UserDataShareUser","data":{"type":"object","required":["type","userId"],"properties":{"type":{"type":"string","enum":["SHARE_USER"]},"userId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Users"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" who downloaded the asset"},"children":[]}]}]}],"example":"google-oauth2|110955770826801837334"}}}},"components/schemas/UserDataPortalUser":{"id":"components/schemas/UserDataPortalUser","kind":"json-schema","title":"UserDataPortalUser","data":{"type":"object","required":["type","userId","portalId"],"properties":{"type":{"type":"string","enum":["PORTAL_USER"]},"userId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Users"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" who downloaded the asset"},"children":[]}]}]}],"example":"google-oauth2|110955770826801837334"},"portalId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Portals"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Portal"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the user who downloaded the asset was in"},"children":[]}]}]}],"example":"55f9964c-095d-4b8b-bb5e-4118d2e76ad0"}}}},"components/schemas/UserDataUnknown":{"id":"components/schemas/UserDataUnknown","kind":"json-schema","title":"UserDataUnknown","data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["UNKNOWN"]}}}},"components/schemas/UserData":{"id":"components/schemas/UserData","kind":"json-schema","title":"UserData","data":{"oneOf":[{"$ref":"#/components/schemas/UserDataAccountUser"},{"$ref":"#/components/schemas/UserDataShareUser"},{"$ref":"#/components/schemas/UserDataPortalUser"},{"$ref":"#/components/schemas/UserDataUnknown"}],"discriminator":{"propertyName":"type","mapping":{"ACCOUNT_USER":"#/components/schemas/UserDataAccountUser","SHARE_USER":"#/components/schemas/UserDataShareUser","PORTAL_USER":"#/components/schemas/UserDataPortalUser","UNKNOWN":"#/components/schemas/UserDataUnknown"}}}},"components/schemas/AssetDownloadEvent":{"id":"components/schemas/AssetDownloadEvent","kind":"json-schema","title":"AssetDownloadEvent","data":{"type":"object","required":["id","accountId","assetId","assetFileId","dateTime","downloadType","downloadDescription","userData"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the ["},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetDownloadEvent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"]"},"children":[]}]}]}],"example":"a52b5315-15b8-417f-b742-d6902108bac1"},"accountId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the ["},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetDownloadEvent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"] was for"},"children":[]}]}]}],"example":"cfb665ca-ce35-4418-b9d5-70ee815db4bd"},"assetId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the ["},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetDownloadEvent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"] was for"},"children":[]}]}]}],"example":"7af90a8b-7ccd-430f-a85d-e8614015bc47"},"assetFileId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/getassetfiles"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetFile"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the ["},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetDownloadEvent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"] was for"},"children":[]}]}]}],"example":"7af90a8b-7ccd-430f-a85d-e8614015bc47"},"dateTime":{"type":"string","format":"date-time","description":"The datetime of the asset download in ISO datetime format","example":"2021-02-17T09:24:01.417Z"},"downloadType":{"type":"string","enum":["ORIGINAL","PRESET","CUSTOM","UNKNOWN"],"description":"Whether the download was of the original file, a preset transformation or a custom transformation","example":"ORIGINAL"},"downloadDescription":{"type":"string","description":"A human-readable description of the download.","example":"ORIGINAL"},"downloadPresetId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PresetTransformation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"downloadType=PRESET"},"children":[]}]}]}],"example":"ORIGINAL"},"userData":{"$ref":"#/components/schemas/UserData"}}}},"components/schemas/AssetDownloadEventWithPermittedActions":{"id":"components/schemas/AssetDownloadEventWithPermittedActions","kind":"json-schema","title":"AssetDownloadEventWithPermittedActions","data":{"type":"object","required":["result","permittedActions"],"properties":{"result":{"$ref":"#/components/schemas/AssetDownloadEvent"},"permittedActions":{"type":"array","items":{"$ref":"#/components/schemas/PermittedAction"}}}}},"components/schemas/EventAggregationValueResponse":{"id":"components/schemas/EventAggregationValueResponse","kind":"json-schema","title":"EventAggregationValueResponse","data":{"type":"object","required":["key","value"],"properties":{"type":{"type":"string"},"value":{"type":"string","description":"The value of the aggregation","example":109}}}},"components/schemas/EventAggregationBucket":{"id":"components/schemas/EventAggregationBucket","kind":"json-schema","title":"EventAggregationBucket","data":{"type":"object","required":["key","count"],"properties":{"key":{"type":"string","description":"The unique name of the bucket","example":null},"count":{"type":"integer","description":"The number of events in the bucket","example":15}}}},"components/schemas/EventAggregationBucketResponse":{"id":"components/schemas/EventAggregationBucketResponse","kind":"json-schema","title":"EventAggregationBucketResponse","data":{"type":"object","required":["key","buckets"],"properties":{"type":{"type":"string"},"buckets":{"description":"The collection of unique buckets within the requested aggregation","type":"array","items":{"$ref":"#/components/schemas/EventAggregationBucket"}}}}},"components/schemas/EventAggregationResponse":{"id":"components/schemas/EventAggregationResponse","kind":"json-schema","title":"EventAggregationResponse","data":{"oneOf":[{"$ref":"#/components/schemas/EventAggregationValueResponse"},{"$ref":"#/components/schemas/EventAggregationBucketResponse"}],"discriminator":{"propertyName":"type","mapping":{"VALUE":"#/components/schemas/EventAggregationValueResponse","BUCKET":"#/components/schemas/EventAggregationBucketResponse"}}}},"components/schemas/AssetDownloadEventSearch":{"id":"components/schemas/AssetDownloadEventSearch","kind":"json-schema","title":"AssetDownloadEventSearch","data":{"type":"object","required":["results","totalResults","aggregations"],"properties":{"results":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The specified page of ["},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetDownloadEvent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"] resources which match the search criterion"},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/AssetDownloadEventWithPermittedActions"}},"totalResults":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total number of ["},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetDownloadEvent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"] resources which match the search criterion"},"children":[]}]}]}],"example":15},"aggregations":{"type":"object","description":"A map of the aggregations requested keyed on the user provided key in the request","additionalProperties":{"$ref":"#/components/schemas/EventAggregationResponse"}}}}},"components/schemas/WelcomeMessage":{"id":"components/schemas/WelcomeMessage","kind":"json-schema","title":"WelcomeMessage","data":{"type":"object","properties":{"title":{"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":"Optional title of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Welcome Message"},"children":[]}]}]}],"example":"Welcome to our reseller portal"},"body":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional body of text displayed below the title in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Welcome Message"},"children":[]}]}]}],"nullable":true,"type":"string","example":"Take a look around our reseller portal and quickly find all the assets you need. Happy browsing!"}}}},"components/schemas/PortalRequest":{"id":"components/schemas/PortalRequest","kind":"json-schema","title":"PortalRequest","data":{"type":"object","required":["name","slug","whitelistedFolderFieldOptionIds","welcomeMessage","showRecentlyAddedAssets"],"properties":{"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Portals"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Portal"},"children":[]}]}]}]}],"example":"Reseller portal"},"slug":{"type":"string","description":"A human readable unique identifier, used in the Dash portal URL","example":"reseller-portal"},"whitelistedFolderFieldOptionIds":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The folder "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"s which portal users will have permission to view/download assets from.  Users will also have permission on the descendants of the specified field options."},"children":[]}]}]}],"type":"array","items":{"type":"string"},"example":["4cb261ad-dffb-414e-89cf-6902e3031d44","4e14dc90-eb7b-4fd2-87e5-e8968c236ec0"]},"welcomeMessage":{"$ref":"#/components/schemas/WelcomeMessage"},"showRecentlyAddedAssets":{"type":"boolean","description":"Whether this portal should include a preview of recently added assets","example":true},"passcode":{"type":"string","nullable":true,"description":"A passcode that must be provided when viewing a portal.  Note that this is NOT a password and as such is stored in plain text","example":"LetMeInPlease"},"assetPermittedActions":{"$ref":"#/components/schemas/AssetPermittedActionsWithDefault"}}}},"components/schemas/Portal":{"id":"components/schemas/Portal","kind":"json-schema","title":"Portal","data":{"type":"object","required":["id","accountId","name","currentSlug","slugs","whitelistedFolderFieldOptionIds","welcomeMessage","showRecentlyAddedAssets","assetPermittedActions"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Portals"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Portal"},"children":[]}]}]}]}],"example":"55f9964c-095d-4b8b-bb5e-4118d2e76ad0"},"accountId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Portals"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Portal"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" belongs to"},"children":[]}]}]}],"type":"string","example":"cfb665ca-ce35-4418-b9d5-70ee815db4bd"},"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Portals"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Portal"},"children":[]}]}]}]}],"example":"Reseller portal"},"currentSlug":{"type":"string","description":"A human readable unique identifier, used in the Dash portal URL","example":"reseller-portal"},"slugs":{"description":"The set of all slugs that have ever been used, maintained so that old share URLs can still work","type":"array","items":{"type":"string"},"example":["reseller-portal","old-slug-here"]},"whitelistedFolderFieldOptionIds":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The folder "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"s which portal users will have permission to view/download assets from."},"children":[]}]}]}],"type":"array","items":{"type":"string"},"example":["4cb261ad-dffb-414e-89cf-6902e3031d44","4e14dc90-eb7b-4fd2-87e5-e8968c236ec0"]},"welcomeMessage":{"$ref":"#/components/schemas/WelcomeMessage"},"showRecentlyAddedAssets":{"type":"boolean","description":"Whether this portal should include a preview of recently added assets","example":true},"passcode":{"type":"string","nullable":true,"description":"A passcode that must be provided when viewing a portal.  Note that this is NOT a password and as such is stored in plain text","example":"LetMeInPlease"},"assetPermittedActions":{"$ref":"#/components/schemas/AssetPermittedActions"},"createdByUserId":{"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 ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Users"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" who created the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Portals"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Portal"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":".  May be null for portals created before this was recorded."},"children":[]}]}]}],"example":"google-oauth2|123456789012345678901"},"dateCreated":{"type":"string","nullable":true,"format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The datetime the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Portals"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Portal"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was created in ISO datetime format.  May be null for portals created before this was recorded."},"children":[]}]}]}],"example":"2021-02-17T09:24:01.417Z"}}}},"components/schemas/PortalWithPermittedActions":{"id":"components/schemas/PortalWithPermittedActions","kind":"json-schema","title":"PortalWithPermittedActions","data":{"type":"object","required":["result","permittedActions"],"properties":{"result":{"$ref":"#/components/schemas/Portal"},"permittedActions":{"type":"array","items":{"$ref":"#/components/schemas/PermittedAction"}}}}},"components/schemas/PortalPatchRequest":{"id":"components/schemas/PortalPatchRequest","kind":"json-schema","title":"PortalPatchRequest","data":{"type":"object","properties":{"name":{"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":"Name of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Portals"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Portal"},"children":[]}]}]}]}],"example":"Reseller portal"},"slug":{"type":"string","nullable":true,"description":"A human readable unique identifier, used in the Dash portal URL","example":"reseller-portal"},"whitelistedFolderFieldOptionIds":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The folder "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"s which portal users will have permission to view/download assets from."},"children":[]}]}]}],"type":"array","nullable":true,"items":{"type":"string"},"example":["4cb261ad-dffb-414e-89cf-6902e3031d44","4e14dc90-eb7b-4fd2-87e5-e8968c236ec0"]},"welcomeMessage":{"type":"object","nullable":true,"allOf":[{"$ref":"#/components/schemas/WelcomeMessage"}]},"showRecentlyAddedAssets":{"type":"boolean","nullable":true,"description":"Whether this portal should include a preview of recently added assets","example":true},"passcode":{"description":"A passcode that must be provided when viewing a portal.  Note that this is NOT a password and as such is stored in plain text","$ref":"#/components/schemas/NullableStringFieldPatch"},"assetPermittedActions":{"$ref":"#/components/schemas/AssetPermittedActionsWithDefault"}}}},"components/schemas/CreatedByCurrentUserSearchCriterion":{"id":"components/schemas/CreatedByCurrentUserSearchCriterion","kind":"json-schema","title":"CreatedByCurrentUserSearchCriterion","data":{"allOf":[{"$ref":"#/components/schemas/SearchCriterion"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["CREATED_BY_CURRENT_USER"]}}}]}},"components/schemas/PortalSearchCriterion":{"id":"components/schemas/PortalSearchCriterion","kind":"json-schema","title":"PortalSearchCriterion","data":{"oneOf":[{"$ref":"#/components/schemas/MatchAllSearchCriterion"},{"$ref":"#/components/schemas/CreatedByCurrentUserSearchCriterion"}],"discriminator":{"propertyName":"type","mapping":{"MATCH_ALL":"#/components/schemas/MatchAllSearchCriterion","CREATED_BY_CURRENT_USER":"#/components/schemas/CreatedByCurrentUserSearchCriterion"}}}},"components/schemas/PortalSortField":{"id":"components/schemas/PortalSortField","kind":"json-schema","title":"PortalSortField","data":{"type":"string","enum":["NAME"],"example":"NAME","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Portals"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Portal"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property value"},"children":[]}]}]}]}},"components/schemas/PortalSort":{"id":"components/schemas/PortalSort","kind":"json-schema","title":"PortalSort","data":{"type":"object","required":["field","order"],"properties":{"field":{"$ref":"#/components/schemas/PortalSortField"},"order":{"$ref":"#/components/schemas/SortOrder"}}}},"components/schemas/PortalSearchRequest":{"id":"components/schemas/PortalSearchRequest","kind":"json-schema","title":"PortalSearchRequest","data":{"allOf":[{"$ref":"#/components/schemas/BasePaginatedSearchInAccountRequest"},{"type":"object","required":["criterion","sorts"],"properties":{"criterion":{"description":"The search criterion","$ref":"#/components/schemas/PortalSearchCriterion"},"sorts":{"description":"Sorts to be applied to the search in order of precedence","type":"array","items":{"$ref":"#/components/schemas/PortalSort"}}}}]}},"components/schemas/PortalSearch":{"id":"components/schemas/PortalSearch","kind":"json-schema","title":"PortalSearch","data":{"type":"object","required":["results","totalResults"],"properties":{"results":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The specified page of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Portals"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Portal"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources which match the search criterion"},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/PortalWithPermittedActions"}},"totalResults":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total number of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Portals"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Portal"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources which match the search criterion"},"children":[]}]}]}],"example":15}}}},"components/schemas/PubliclyAvailablePortalData":{"id":"components/schemas/PubliclyAvailablePortalData","kind":"json-schema","title":"PubliclyAvailablePortalData","data":{"type":"object","required":["id","accountId","name","currentSlug","slugs","whitelistedFolderFieldOptionIds","welcomeMessage","showRecentlyAddedAssets","requiresPasscode","assetPermittedActions"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Portals"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Portal"},"children":[]}]}]}]}],"example":"55f9964c-095d-4b8b-bb5e-4118d2e76ad0"},"accountId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Portals"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Portal"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" belongs to"},"children":[]}]}]}],"type":"string","example":"cfb665ca-ce35-4418-b9d5-70ee815db4bd"},"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Portals"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Portal"},"children":[]}]}]}]}],"example":"Reseller portal"},"currentSlug":{"type":"string","description":"A human readable unique identifier, used in the Dash portal URL","example":"reseller-portal"},"slugs":{"description":"The set of all slugs that have ever been used, maintained so that old share URLs can still work","type":"array","items":{"type":"string"},"example":["reseller-portal","old-slug-here"]},"whitelistedFolderFieldOptionIds":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The folder "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Field-Options"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldOption"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"s which portal users will have permission to view/download assets from."},"children":[]}]}]}],"type":"array","items":{"type":"string"},"example":["4cb261ad-dffb-414e-89cf-6902e3031d44","4e14dc90-eb7b-4fd2-87e5-e8968c236ec0"]},"welcomeMessage":{"$ref":"#/components/schemas/WelcomeMessage"},"showRecentlyAddedAssets":{"type":"boolean","description":"Whether this portal should include a preview of recently added assets","example":true},"requiresPasscode":{"type":"boolean","description":"Whether access to this portal requires a passcode","example":true},"assetPermittedActions":{"$ref":"#/components/schemas/AssetPermittedActions"}}}},"components/schemas/PubliclyAvailablePortalDataWithPermittedActions":{"id":"components/schemas/PubliclyAvailablePortalDataWithPermittedActions","kind":"json-schema","title":"PubliclyAvailablePortalDataWithPermittedActions","data":{"type":"object","required":["result","permittedActions"],"properties":{"result":{"$ref":"#/components/schemas/PubliclyAvailablePortalData"},"permittedActions":{"type":"array","items":{"$ref":"#/components/schemas/PermittedAction"}}}}},"components/schemas/PortalEmailRequest":{"id":"components/schemas/PortalEmailRequest","kind":"json-schema","title":"PortalEmailRequest","data":{"type":"object","properties":{"portalId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID for the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Portals"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Portal"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to be emailed"},"children":[]}]}]}],"example":"55f9964c-095d-4b8b-bb5e-4118d2e76ad0"},"email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The email address to send the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Portals"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Portal"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to"},"children":[]}]}]}],"example":"john.smith@gmail.com"}}}},"components/schemas/GuestUploadRequest":{"id":"components/schemas/GuestUploadRequest","kind":"json-schema","title":"GuestUploadRequest","data":{"type":"object","required":["folderFieldOptionId","name"],"properties":{"folderFieldOptionId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Folder"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where guest files are uploaded  when this "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Guest-Uploads"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GuestUpload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" URL is used"},"children":[]}]}]}],"type":"string","example":"c4e146aa3-543a-4d58-bf99-0d33cf73e942"},"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A human readable name for the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Guest-Uploads"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GuestUpload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" URL"},"children":[]}]}]}],"example":"Social media Content"},"message":{"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":"Optional message shown to anyone that visits the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Guest-Uploads"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GuestUpload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" URL"},"children":[]}]}]}],"example":"Please upload your favourite social media pics for approval"},"messageHeading":{"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":"Optional message header shown to anyone that visits the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Guest-Uploads"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GuestUpload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" URL"},"children":[]}]}]}],"example":"Social media uploads"}}}},"components/schemas/GuestUpload":{"id":"components/schemas/GuestUpload","kind":"json-schema","title":"GuestUpload","data":{"type":"object","required":["id","accountId","folderFieldOptionId","name","currentSlug","slugs"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Guest-Uploads"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GuestUpload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" URL"},"children":[]}]}]}],"example":"55f9964c-095d-4b8b-bb5e-4118d2e76ad0"},"accountId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Guest-Uploads"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GuestUpload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" URL belongs to"},"children":[]}]}]}],"type":"string","example":"cfb665ca-ce35-4418-b9d5-70ee815db4bd"},"folderFieldOptionId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Folder"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where guest files are uploaded  when this "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Guest-Uploads"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GuestUpload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" URL is used"},"children":[]}]}]}],"type":"string","example":"c4e146aa3-543a-4d58-bf99-0d33cf73e942"},"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A human readable name for the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Guest-Uploads"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GuestUpload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" URL"},"children":[]}]}]}],"example":"Social media Content"},"currentSlug":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A human readable unique identifier based on the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Guest-Uploads"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GuestUpload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name, used in the GuestUpload URL"},"children":[]}]}]}],"example":"puaon-social-media-content"},"slugs":{"description":"The set of all slugs that have ever been used, maintained so that old shared GuestUpload URLs can still work","type":"array","items":{"type":"string"},"example":["puaon-social-media-content","azxmq-social-media-old"]},"message":{"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":"Optional message shown to anyone that visits the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Guest-Uploads"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GuestUpload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" URL"},"children":[]}]}]}],"example":"Please upload your favourite social media pics for approval"},"messageHeading":{"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":"Optional message header shown to anyone that visits the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Guest-Uploads"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GuestUpload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" URL"},"children":[]}]}]}],"example":"Social media uploads"}}}},"components/schemas/GuestUploadWithPermittedActions":{"id":"components/schemas/GuestUploadWithPermittedActions","kind":"json-schema","title":"GuestUploadWithPermittedActions","data":{"type":"object","required":["result","permittedActions"],"properties":{"result":{"$ref":"#/components/schemas/GuestUpload"},"permittedActions":{"type":"array","items":{"$ref":"#/components/schemas/PermittedAction"}}}}},"components/schemas/GuestUploadPatchRequest":{"id":"components/schemas/GuestUploadPatchRequest","kind":"json-schema","title":"GuestUploadPatchRequest","data":{"type":"object","properties":{"folderFieldOptionId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Folder"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where guest files are uploaded  when this "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Guest-Uploads"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GuestUpload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" URL is used"},"children":[]}]}]}],"type":"string","nullable":true,"example":"c4e146aa3-543a-4d58-bf99-0d33cf73e942"},"name":{"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":"A human readable name for the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Guest-Uploads"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GuestUpload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" URL"},"children":[]}]}]}],"example":"Social media Content"},"message":{"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":"Message shown to anyone that visits the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Guest-Uploads"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GuestUpload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" URL"},"children":[]}]}]}],"example":"Please upload your favourite social media pics for approval"},"messageHeading":{"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":"Optional message header shown to anyone that visits the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Guest-Uploads"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GuestUpload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" URL"},"children":[]}]}]}],"example":"Social media uploads"}}}},"components/schemas/GuestUploadSearchCriterion":{"id":"components/schemas/GuestUploadSearchCriterion","kind":"json-schema","title":"GuestUploadSearchCriterion","data":{"oneOf":[{"$ref":"#/components/schemas/MatchAllSearchCriterion"}],"discriminator":{"propertyName":"type","mapping":{"MATCH_ALL":"#/components/schemas/MatchAllSearchCriterion"}}}},"components/schemas/GuestUploadSortField":{"id":"components/schemas/GuestUploadSortField","kind":"json-schema","title":"GuestUploadSortField","data":{"type":"string","enum":["NAME"],"example":"NAME","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Guest-Uploads"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GuestUpload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property value"},"children":[]}]}]}]}},"components/schemas/GuestUploadSort":{"id":"components/schemas/GuestUploadSort","kind":"json-schema","title":"GuestUploadSort","data":{"type":"object","required":["field","order"],"properties":{"field":{"$ref":"#/components/schemas/GuestUploadSortField"},"order":{"$ref":"#/components/schemas/SortOrder"}}}},"components/schemas/GuestUploadSearchRequest":{"id":"components/schemas/GuestUploadSearchRequest","kind":"json-schema","title":"GuestUploadSearchRequest","data":{"allOf":[{"$ref":"#/components/schemas/BasePaginatedSearchInAccountRequest"},{"type":"object","required":["criterion","sorts"],"properties":{"criterion":{"description":"The search criterion","$ref":"#/components/schemas/GuestUploadSearchCriterion"},"sorts":{"description":"Sorts to be applied to the search in order of precedence","type":"array","items":{"$ref":"#/components/schemas/GuestUploadSort"}}}}]}},"components/schemas/GuestUploadSearch":{"id":"components/schemas/GuestUploadSearch","kind":"json-schema","title":"GuestUploadSearch","data":{"type":"object","required":["results","totalResults"],"properties":{"results":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The specified page of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Guest-Uploads"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GuestUpload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources which match the search criterion"},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/GuestUploadWithPermittedActions"}},"totalResults":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total number of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Guest-Uploads"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GuestUpload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources which match the search criterion"},"children":[]}]}]}],"example":15}}}},"components/schemas/GuestUploadEmailRequest":{"id":"components/schemas/GuestUploadEmailRequest","kind":"json-schema","title":"GuestUploadEmailRequest","data":{"type":"object","required":["guestUploadId","email"],"properties":{"guestUploadId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID for the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Guest-Uploads"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GuestUpload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" URL to be emailed"},"children":[]}]}]}],"example":"55f9964c-095d-4b8b-bb5e-4118d2e76ad0"},"email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The email address to send the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Guest-Uploads"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GuestUpload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" URL to"},"children":[]}]}]}],"example":"john.smith@gmail.com"}}}},"components/schemas/GuestUploadAccessTokenRequest":{"id":"components/schemas/GuestUploadAccessTokenRequest","kind":"json-schema","title":"GuestUploadAccessTokenRequest","data":{"type":"object","required":["id","email"],"properties":{"guestUploadId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID for the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Guest-Uploads"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GuestUpload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" URL"},"children":[]}]}]}],"example":"55f9964c-095d-4b8b-bb5e-4118d2e76ad0"},"email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The email address of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Guest-Uploads"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GuestUpload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" user"},"children":[]}]}]}],"example":"john.smith@gmail.com"}}}},"components/schemas/PubliclyAvailableGuestUploadData":{"id":"components/schemas/PubliclyAvailableGuestUploadData","kind":"json-schema","title":"PubliclyAvailableGuestUploadData","data":{"type":"object","required":["id","name"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Guest-Uploads"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GuestUpload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" URL"},"children":[]}]}]}],"example":"55f9964c-095d-4b8b-bb5e-4118d2e76ad0"},"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A human readable name for the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Guest-Uploads"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GuestUpload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" URL"},"children":[]}]}]}],"example":"Social media Content"},"message":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional message shown to anyone that visits the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Guest-Uploads"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GuestUpload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" URL"},"children":[]}]}]}],"example":"Please upload your favourite social media pics for approval"},"messageHeading":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional message header shown to anyone that visits the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Guest-Uploads"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GuestUpload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" URL"},"children":[]}]}]}],"example":"Social media uploads"}}}},"components/schemas/PubliclyAvailableGuestUploadDataWithPermittedActions":{"id":"components/schemas/PubliclyAvailableGuestUploadDataWithPermittedActions","kind":"json-schema","title":"PubliclyAvailableGuestUploadDataWithPermittedActions","data":{"type":"object","required":["result","permittedActions"],"properties":{"result":{"$ref":"#/components/schemas/PubliclyAvailableGuestUploadData"},"permittedActions":{"type":"array","items":{"$ref":"#/components/schemas/PermittedAction"}}}}},"components/schemas/GoogleCloudConnectionRequest":{"id":"components/schemas/GoogleCloudConnectionRequest","kind":"json-schema","title":"GoogleCloudConnectionRequest","data":{"type":"object","required":["type","authorizationCode","redirectUri"],"properties":{"type":{"type":"string"},"authorizationCode":{"type":"string","description":"The temporary OAuth2 authorization code that Dash can exchange for an access token to a user's Google Cloud","example":"e2b03444-8c5d-44ed-bd9f-7eee882bdf81"},"redirectUri":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The redirect URI that was specified when getting the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorizationCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"https://auth.dash.app/cloud-connect"}}}},"components/schemas/DropboxCloudConnectionRequest":{"id":"components/schemas/DropboxCloudConnectionRequest","kind":"json-schema","title":"DropboxCloudConnectionRequest","data":{"type":"object","required":["type","authorizationCode","redirectUri"],"properties":{"type":{"type":"string"},"authorizationCode":{"type":"string","description":"The temporary OAuth2 authorization code that Dash can exchange for an access token to a user's Dropbox","example":"e2b03444-8c5d-44ed-bd9f-7eee882bdf81"},"redirectUri":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The redirect URI that was specified when getting the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorizationCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"https://auth.dash.app/cloud-connect"}}}},"components/schemas/CloudConnectionRequest":{"id":"components/schemas/CloudConnectionRequest","kind":"json-schema","title":"CloudConnectionRequest","data":{"oneOf":[{"$ref":"#/components/schemas/GoogleCloudConnectionRequest"},{"$ref":"#/components/schemas/DropboxCloudConnectionRequest"}],"discriminator":{"propertyName":"type","mapping":{"GOOGLE":"#/components/schemas/GoogleCloudConnectionRequest","DROPBOX":"#/components/schemas/DropboxCloudConnectionRequest"}}}},"components/schemas/BaseCloudConnection":{"id":"components/schemas/BaseCloudConnection","kind":"json-schema","title":"BaseCloudConnection","data":{"type":"object","required":["type","id","accountId","creatorId"],"properties":{"type":{"type":"string"},"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID for the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Cloud-Connections"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CloudConnection"},"children":[]}]}]}]}],"example":"e2b03444-8c5d-44ed-bd9f-7eee882bdf81"},"accountId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Cloud-Connections"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CloudConnection"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" belongs to"},"children":[]}]}]}],"type":"string","example":"cfb665ca-ce35-4418-b9d5-70ee815db4bd"},"creatorId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Users"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" who created the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Cloud-Connections"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CloudConnection"},"children":[]}]}]}]}],"type":"string","example":"google-oauth2|110955770826801837334"}}}},"components/schemas/GoogleCloudConnection":{"id":"components/schemas/GoogleCloudConnection","kind":"json-schema","title":"GoogleCloudConnection","data":{"allOf":[{"$ref":"#/components/schemas/BaseCloudConnection"},{"type":"object","required":["email"],"properties":{"email":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The email address of the user associated with the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Cloud-Connections"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CloudConnection"},"children":[]}]}]}]}],"type":"string","example":"john.smith@gmail.com"},"name":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the user associated with the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Cloud-Connections"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CloudConnection"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", if they have one"},"children":[]}]}]}],"type":"string","nullable":true,"example":"John Smith"},"picture":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A URL for the profile picture of the user associated with the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Cloud-Connections"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CloudConnection"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", if they have one"},"children":[]}]}]}],"example":"https://example.com/john-smith-picture.jpg","type":"string","nullable":true}}}]}},"components/schemas/DropboxCloudConnection":{"id":"components/schemas/DropboxCloudConnection","kind":"json-schema","title":"DropboxCloudConnection","data":{"allOf":[{"$ref":"#/components/schemas/BaseCloudConnection"},{"type":"object","required":["email"],"properties":{"email":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The email address of the user associated with the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Cloud-Connections"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CloudConnection"},"children":[]}]}]}]}],"type":"string","example":"john.smith@gmail.com"},"name":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the user associated with the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Cloud-Connections"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CloudConnection"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", if they have one"},"children":[]}]}]}],"type":"string","nullable":true,"example":"John Smith"},"picture":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A URL for the profile picture of the user associated with the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Cloud-Connections"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CloudConnection"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", if they have one"},"children":[]}]}]}],"example":"https://example.com/john-smith-picture.jpg","type":"string","nullable":true}}}]}},"components/schemas/CloudConnection":{"id":"components/schemas/CloudConnection","kind":"json-schema","title":"CloudConnection","data":{"oneOf":[{"$ref":"#/components/schemas/GoogleCloudConnection"},{"$ref":"#/components/schemas/DropboxCloudConnection"}],"discriminator":{"propertyName":"type","mapping":{"GOOGLE":"#/components/schemas/GoogleCloudConnection","DROPBOX":"#/components/schemas/DropboxCloudConnection"}}}},"components/schemas/CloudConnectionWithPermittedActions":{"id":"components/schemas/CloudConnectionWithPermittedActions","kind":"json-schema","title":"CloudConnectionWithPermittedActions","data":{"type":"object","required":["result","permittedActions"],"properties":{"result":{"$ref":"#/components/schemas/CloudConnection"},"permittedActions":{"type":"array","items":{"$ref":"#/components/schemas/PermittedAction"}}}}},"components/schemas/CloudObjectRootFolder":{"id":"components/schemas/CloudObjectRootFolder","kind":"json-schema","title":"CloudObjectRootFolder","data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["ROOT_FOLDER"]}}}},"components/schemas/CloudObjectIdValue":{"id":"components/schemas/CloudObjectIdValue","kind":"json-schema","title":"CloudObjectIdValue","data":{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["VALUE"]},"value":{"type":"string"}}}},"components/schemas/CloudObjectIdValueOrRootFolder":{"id":"components/schemas/CloudObjectIdValueOrRootFolder","kind":"json-schema","title":"CloudObjectIdValueOrRootFolder","data":{"oneOf":[{"$ref":"#/components/schemas/CloudObjectRootFolder"},{"$ref":"#/components/schemas/CloudObjectIdValue"}],"discriminator":{"propertyName":"type","mapping":{"ROOT_FOLDER":"#/components/schemas/CloudObjectRootFolder","VALUE":"#/components/schemas/CloudObjectIdValue"}}}},"components/schemas/BaseCloudObject":{"id":"components/schemas/BaseCloudObject","kind":"json-schema","title":"BaseCloudObject","data":{"type":"object","required":["id","parentId","name","type"],"properties":{"id":{"type":"string","description":"Unique identifier of the cloud object","example":"be161977-d44e-4888-af3c-66522e223963"},"parentId":{"$ref":"#/components/schemas/CloudObjectIdValueOrRootFolder"},"name":{"description":"The name of the cloud object. May or may not contain a file extension depending on the Cloud Drive implementation","type":"string","example":"My File"},"type":{"type":"string","description":"The cloud object type","enum":["FILE","FOLDER","FOLDER_SHORTCUT","FILE_SHORTCUT"]}}}},"components/schemas/CloudFile":{"id":"components/schemas/CloudFile","kind":"json-schema","title":"CloudFile","data":{"allOf":[{"$ref":"#/components/schemas/BaseCloudObject"},{"type":"object","required":["type","size","dateLastModified"],"properties":{"type":{"type":"string","description":"The cloud object type","enum":["FILE"]},"size":{"type":"integer","description":"The size of the cloud file","example":15318362},"dateLastModified":{"type":"string","description":"The datetime the cloud file was last modified in ISO datetime format","example":"2021-02-17T09:24:01.417Z"},"thumbnailUrl":{"type":"string","nullable":true,"description":"URL for the file thumbnail if available"},"iconUrl":{"type":"string","nullable":true,"description":"URL for the file icon if available"}}}]}},"components/schemas/CloudFolder":{"id":"components/schemas/CloudFolder","kind":"json-schema","title":"CloudFolder","data":{"allOf":[{"$ref":"#/components/schemas/BaseCloudObject"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"The cloud object type","enum":["FOLDER"]}}}]}},"components/schemas/CloudFileShortcut":{"id":"components/schemas/CloudFileShortcut","kind":"json-schema","title":"CloudFileShortcut","data":{"allOf":[{"$ref":"#/components/schemas/BaseCloudObject"},{"type":"object","required":["type","targetId"],"properties":{"type":{"type":"string","description":"The cloud object type","enum":["FILE_SHORTCUT"]},"targetId":{"type":"string","description":"The id of the cloud object the shortcut points to"}}}]}},"components/schemas/CloudFolderShortcut":{"id":"components/schemas/CloudFolderShortcut","kind":"json-schema","title":"CloudFolderShortcut","data":{"allOf":[{"$ref":"#/components/schemas/BaseCloudObject"},{"type":"object","required":["type","targetId"],"properties":{"type":{"type":"string","description":"The cloud object type","enum":["FOLDER_SHORTCUT"]},"targetId":{"type":"string","description":"The id of the cloud object the shortcut points to"}}}]}},"components/schemas/CloudObject":{"id":"components/schemas/CloudObject","kind":"json-schema","title":"CloudObject","data":{"oneOf":[{"$ref":"#/components/schemas/CloudFile"},{"$ref":"#/components/schemas/CloudFolder"},{"$ref":"#/components/schemas/CloudFileShortcut"},{"$ref":"#/components/schemas/CloudFolderShortcut"}],"discriminator":{"propertyName":"type","mapping":{"FILE":"#/components/schemas/CloudFile","FOLDER":"#/components/schemas/CloudFolder","FILE_SHORTCUT":"#/components/schemas/CloudFileShortcut","FOLDER_SHORTCUT":"#/components/schemas/CloudFolderShortcut"}}}},"components/schemas/CloudObjectSearchField":{"id":"components/schemas/CloudObjectSearchField","kind":"json-schema","title":"CloudObjectSearchField","data":{"type":"string","enum":["PARENT_ID"],"example":"PARENT_ID"}},"components/schemas/CloudObjectFieldEqualsSearchCriterion":{"id":"components/schemas/CloudObjectFieldEqualsSearchCriterion","kind":"json-schema","title":"CloudObjectFieldEqualsSearchCriterion","data":{"allOf":[{"$ref":"#/components/schemas/SearchCriterion"},{"type":"object","required":["type","field","value"],"properties":{"type":{"type":"string","enum":["FIELD_EQUALS"]},"field":{"$ref":"#/components/schemas/CloudObjectSearchField"},"value":{"$ref":"#/components/schemas/CloudObjectIdValueOrRootFolder"}}}]}},"components/schemas/CloudObjectMatchesTextSearchCriterion":{"id":"components/schemas/CloudObjectMatchesTextSearchCriterion","kind":"json-schema","title":"CloudObjectMatchesTextSearchCriterion","data":{"allOf":[{"$ref":"#/components/schemas/SearchCriterion"},{"type":"object","required":["type","text"],"properties":{"type":{"type":"string","enum":["MATCHES_TEXT"]},"text":{"type":"string","description":"The text to match on","example":"interesting things"}}}]}},"components/schemas/CloudObjectSearchCriterion":{"id":"components/schemas/CloudObjectSearchCriterion","kind":"json-schema","title":"CloudObjectSearchCriterion","data":{"oneOf":[{"$ref":"#/components/schemas/CloudObjectFieldEqualsSearchCriterion"},{"$ref":"#/components/schemas/CloudObjectMatchesTextSearchCriterion"}],"discriminator":{"propertyName":"type","mapping":{"FIELD_EQUALS":"#/components/schemas/CloudObjectFieldEqualsSearchCriterion","MATCHES_TEXT":"#/components/schemas/CloudObjectMatchesTextSearchCriterion"}}}},"components/schemas/CloudObjectPagedSearchRequest":{"id":"components/schemas/CloudObjectPagedSearchRequest","kind":"json-schema","title":"CloudObjectPagedSearchRequest","data":{"type":"object","required":["cloudConnectionId","criterion"],"properties":{"cloudConnectionId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID for the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Cloud-Connections"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CloudConnection"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to search in"},"children":[]}]}]}],"example":"e2b03444-8c5d-44ed-bd9f-7eee882bdf81"},"criterion":{"description":"The search criterion","$ref":"#/components/schemas/CloudObjectSearchCriterion"},"pageSize":{"description":"The maximum number of items to return in the result set.","type":"integer","minimum":0,"maximum":1000,"example":100,"default":100},"pageToken":{"type":"string","nullable":true,"description":"The page token to continue a previous search","example":"hds7bs78bbw7v8w"}}}},"components/schemas/CloudObjectPagedSearch":{"id":"components/schemas/CloudObjectPagedSearch","kind":"json-schema","title":"CloudObjectPagedSearch","data":{"type":"object","required":["results"],"properties":{"results":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The specified page of ["},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CloudObject"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"] resources which match the search criterion"},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/CloudObject"}},"nextPage":{"type":"object","nullable":true,"allOf":[{"$ref":"#/components/schemas/CloudObjectPagedSearchRequest"}]}}}},"components/schemas/CloudObjectsSelectorByIds":{"id":"components/schemas/CloudObjectsSelectorByIds","kind":"json-schema","title":"CloudObjectsSelectorByIds","data":{"type":"object","required":["type","cloudObjectIds"],"properties":{"type":{"enum":["BY_IDS"]},"cloudObjectIds":{"type":"array","description":"The list of cloud object ids to select","items":{"type":"string"}}}}},"components/schemas/CloudObjectsSelector":{"id":"components/schemas/CloudObjectsSelector","kind":"json-schema","title":"CloudObjectsSelector","data":{"oneOf":[{"$ref":"#/components/schemas/CloudObjectsSelectorByIds"}],"discriminator":{"propertyName":"type","mapping":{"BY_IDS":"#/components/schemas/CloudObjectsSelectorByIds"}}}},"components/schemas/CloudObjectPathMapping":{"id":"components/schemas/CloudObjectPathMapping","kind":"json-schema","title":"CloudObjectPathMapping","data":{"type":"object","required":["matchPrefix","removePrefix","addPrefix"],"properties":{"matchPrefix":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Apply mappings to ["},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CloudObject"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"] resources with a path that matches this prefix"},"children":[]}]}]}],"example":"path/to/folder"},"removePrefix":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Remove this prefix from the path of matching ["},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CloudObject"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"] resources"},"children":[]}]}]}],"example":"path/to/"},"addPrefix":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Add this prefix to the path of matching ["},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CloudObject"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"] resources"},"children":[]}]}]}],"example":"new-folder/"}}}},"components/schemas/CloudImportJobRequest":{"id":"components/schemas/CloudImportJobRequest","kind":"json-schema","title":"CloudImportJobRequest","data":{"type":"object","required":["cloudConnectionId","criterion","keepFolderStructure","destinationPath"],"properties":{"cloudConnectionId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID for the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Cloud-Connections"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CloudConnection"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to import files from"},"children":[]}]}]}],"example":"e2b03444-8c5d-44ed-bd9f-7eee882bdf81"},"selector":{"$ref":"#/components/schemas/CloudObjectsSelector"},"keepFolderStructure":{"type":"boolean","description":"Whether to maintain the source folder structure beneath the selected objects","example":true},"destinationPath":{"type":"string","description":"The path of the folder in Dash to import the files into. Use an empty string to import to the top level.","example":"path/to/folder"},"pathMappings":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A list of ["},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CloudObjectPathMapping"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"]s to apply to the imported ["},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CloudObject"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"]s"},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/CloudObjectPathMapping"}}}}},"components/schemas/CloudImportResult":{"id":"components/schemas/CloudImportResult","kind":"json-schema","title":"CloudImportResult","data":{"type":"object","required":["totalObjects","foldersSkipped","emptyFilesSkipped","otherFilesSkipped","filesFailedToImport","filesAlreadyImported","filesSuccessfullyImported"],"properties":{"totalObjects":{"type":"integer","example":100},"foldersSkipped":{"type":"integer","example":1},"emptyFilesSkipped":{"type":"integer","example":2},"otherFilesSkipped":{"type":"integer","example":3},"filesFailedToImport":{"type":"integer","example":4},"filesAlreadyImported":{"type":"integer","example":5},"filesSuccessfullyImported":{"type":"integer","example":85}}}},"components/schemas/CloudImportCompletedJob":{"id":"components/schemas/CloudImportCompletedJob","kind":"json-schema","title":"CloudImportCompletedJob","data":{"allOf":[{"$ref":"#/components/schemas/CompletedJob"},{"type":"object","required":["result"],"properties":{"result":{"$ref":"#/components/schemas/CloudImportResult"}}}]}},"components/schemas/CloudImportJob":{"id":"components/schemas/CloudImportJob","kind":"json-schema","title":"CloudImportJob","data":{"oneOf":[{"$ref":"#/components/schemas/InProgressJob"},{"$ref":"#/components/schemas/CloudImportCompletedJob"},{"$ref":"#/components/schemas/FailedJob"}],"discriminator":{"propertyName":"type","mapping":{"IN_PROGRESS":"#/components/schemas/InProgressJob","COMPLETED":"#/components/schemas/CloudImportCompletedJob","FAILED":"#/components/schemas/FailedJob"}}}},"components/schemas/CloudImportJobWithPermittedActions":{"id":"components/schemas/CloudImportJobWithPermittedActions","kind":"json-schema","title":"CloudImportJobWithPermittedActions","data":{"type":"object","required":["result","permittedActions"],"properties":{"result":{"$ref":"#/components/schemas/CloudImportJob"},"permittedActions":{"type":"array","items":{"$ref":"#/components/schemas/PermittedAction"}}}}},"components/schemas/ShopifyConnection":{"id":"components/schemas/ShopifyConnection","kind":"json-schema","title":"ShopifyConnection","data":{"type":"object","required":["id","clientId"],"properties":{"id":{"description":"The shop name that uniquely identifies a Shopify connection","type":"string","example":"example.myshopify.com"},"clientId":{"description":"The Client ID required to use Shopify's App Bridge framework","type":"string","example":"339764aa5d7d5cd60ad55a48d3e4fc8d"}}}},"components/schemas/ShopifyConnectionWithPermittedActions":{"id":"components/schemas/ShopifyConnectionWithPermittedActions","kind":"json-schema","title":"ShopifyConnectionWithPermittedActions","data":{"type":"object","required":["result","permittedActions"],"properties":{"result":{"$ref":"#/components/schemas/ShopifyConnection"},"permittedActions":{"type":"array","items":{"$ref":"#/components/schemas/PermittedAction"}}}}},"components/schemas/LimitedDownloads":{"id":"components/schemas/LimitedDownloads","kind":"json-schema","title":"LimitedDownloads","data":{"type":"object","required":["type","limit"],"properties":{"type":{"type":"string","enum":["LIMITED"]},"limit":{"type":"integer","description":"The maximum number of downloads allowed each month","example":1000}}}},"components/schemas/UnlimitedDownloads":{"id":"components/schemas/UnlimitedDownloads","kind":"json-schema","title":"UnlimitedDownloads","data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["UNLIMITED"]}}}},"components/schemas/Downloads":{"id":"components/schemas/Downloads","kind":"json-schema","title":"Downloads","data":{"oneOf":[{"$ref":"#/components/schemas/LimitedDownloads"},{"$ref":"#/components/schemas/UnlimitedDownloads"}],"discriminator":{"propertyName":"type","mapping":{"LIMITED":"#/components/schemas/LimitedDownloads","UNLIMITED":"#/components/schemas/UnlimitedDownloads"}}}},"components/schemas/TieredValueBasedPlan":{"id":"components/schemas/TieredValueBasedPlan","kind":"json-schema","title":"TieredValueBasedPlan","data":{"type":"object","required":["type","planName","downloads","assetsIncludedInPlan","extraAssets","assets"],"properties":{"type":{"type":"string","enum":["TIERED_VALUE_BASED"]},"planName":{"type":"string","example":"STARTUP","enum":["STARTUP","SMALL_TEAM","GROWING_BRAND","ESTABLISHED_BRAND"]},"downloads":{"$ref":"#/components/schemas/Downloads"},"assetsIncludedInPlan":{"type":"integer","example":2000},"extraAssets":{"type":"integer","example":1000},"assets":{"type":"integer","example":3000}}}},"components/schemas/StorageAndDownloadsPlan":{"id":"components/schemas/StorageAndDownloadsPlan","kind":"json-schema","title":"StorageAndDownloadsPlan","data":{"type":"object","required":["type","planName","downloads","storageIncludedInPlanInGb","extraStorageInGb","storageInGb"],"properties":{"type":{"type":"string","enum":["STORAGE_AND_DOWNLOADS"]},"planName":{"type":"string","example":"STARTUP","enum":["STARTUP","SMALL_TEAM","GROWING_BRAND","ESTABLISHED_BRAND"]},"downloads":{"$ref":"#/components/schemas/Downloads"},"storageIncludedInPlanInGb":{"type":"integer","example":50},"extraStorageInGb":{"type":"integer","example":10},"storageInGb":{"type":"integer","example":60}}}},"components/schemas/StorageAndDownloadsV7Plan":{"id":"components/schemas/StorageAndDownloadsV7Plan","kind":"json-schema","title":"StorageAndDownloadsV7Plan","data":{"type":"object","required":["type","planName","downloads","storageIncludedInPlanInGb","extraStorageInGb","storageInGb"],"properties":{"type":{"type":"string","enum":["STORAGE_AND_DOWNLOADS_V7"]},"planName":{"type":"string","example":"STARTUP","enum":["STARTUP","GROWING_BRAND","ESTABLISHED_BRAND","ENTERPRISE"]},"downloads":{"$ref":"#/components/schemas/Downloads"},"storageIncludedInPlanInGb":{"type":"integer","example":50},"extraStorageInGb":{"type":"integer","example":10},"storageInGb":{"type":"integer","example":60}}}},"components/schemas/StorageAndDownloadsV8Plan":{"id":"components/schemas/StorageAndDownloadsV8Plan","kind":"json-schema","title":"StorageAndDownloadsV8Plan","data":{"type":"object","required":["type","planName","downloads","storageIncludedInPlanInGb","extraStorageInGb","storageInGb"],"properties":{"type":{"type":"string","enum":["STORAGE_AND_DOWNLOADS_V8"]},"planName":{"type":"string","example":"STARTUP","enum":["STARTUP","GROWING_BRAND","ESTABLISHED_BRAND","ENTERPRISE"]},"downloads":{"$ref":"#/components/schemas/Downloads"},"storageIncludedInPlanInGb":{"type":"integer","example":50},"extraStorageInGb":{"type":"integer","example":10},"storageInGb":{"type":"integer","example":60}}}},"components/schemas/FeatureBasedPlan":{"id":"components/schemas/FeatureBasedPlan","kind":"json-schema","title":"FeatureBasedPlan","data":{"type":"object","required":["type","planName","users","storageInGb"],"properties":{"type":{"type":"string","enum":["FEATURE_BASED"]},"planName":{"type":"string","example":"STARTING","enum":["STARTING","GROWING","DASHING"]},"users":{"type":"integer","example":4},"storageInGb":{"type":"integer","example":60}}}},"components/schemas/SliderValueBasedPlan":{"id":"components/schemas/SliderValueBasedPlan","kind":"json-schema","title":"SliderValueBasedPlan","data":{"type":"object","required":["type","downloads","assets"],"properties":{"type":{"type":"string","enum":["SLIDER_VALUE_BASED"]},"downloads":{"type":"integer","example":150},"assets":{"type":"integer","example":3000}}}},"components/schemas/Plan":{"id":"components/schemas/Plan","kind":"json-schema","title":"Plan","data":{"oneOf":[{"$ref":"#/components/schemas/TieredValueBasedPlan"},{"$ref":"#/components/schemas/StorageAndDownloadsPlan"},{"$ref":"#/components/schemas/StorageAndDownloadsV7Plan"},{"$ref":"#/components/schemas/StorageAndDownloadsV8Plan"},{"$ref":"#/components/schemas/FeatureBasedPlan"},{"$ref":"#/components/schemas/SliderValueBasedPlan"}],"discriminator":{"propertyName":"type","mapping":{"TIERED_VALUE_BASED":"#/components/schemas/TieredValueBasedPlan","STORAGE_AND_DOWNLOADS":"#/components/schemas/StorageAndDownloadsPlan","STORAGE_AND_DOWNLOADS_V7":"#/components/schemas/StorageAndDownloadsV7Plan","STORAGE_AND_DOWNLOADS_V8":"#/components/schemas/StorageAndDownloadsV8Plan","FEATURE_BASED":"#/components/schemas/FeatureBasedPlan","SLIDER_VALUE_BASED":"#/components/schemas/SliderValueBasedPlan"}}}},"components/schemas/Address":{"id":"components/schemas/Address","kind":"json-schema","title":"Address","data":{"type":"object","required":["country","line1"],"properties":{"country":{"type":"string","example":"United Kingdom"},"state":{"type":"string","nullable":true,"example":"Texas"},"city":{"type":"string","nullable":true,"example":"Brighton"},"postalCode":{"type":"string","nullable":true,"example":"BN1 1AB"},"line1":{"type":"string","example":"Flat 56"},"line2":{"type":"string","nullable":true,"example":"13 some road"}}}},"components/schemas/Amount":{"id":"components/schemas/Amount","kind":"json-schema","title":"Amount","data":{"type":"object","required":["amountWithTax","amountWithoutTax","includesTax"],"properties":{"amountWithTax":{"type":"integer","description":"The price of the subscription in the lowest denomination of the chosen currency","example":12000},"amountWithoutTax":{"type":"integer","description":"The price of the subscription without tax in the lowest denomination of the chosen currency","example":10000},"includesTax":{"type":"boolean","description":"Whether the price for the subscription includes tax","example":true}}}},"components/schemas/Billing":{"id":"components/schemas/Billing","kind":"json-schema","title":"Billing","data":{"type":"object","required":["name","email","address","period","currency","nextBillingDate","amount"],"properties":{"name":{"type":"string","description":"The name of the billing contact","example":"Example name"},"email":{"type":"string","description":"The email of the billing contact","example":"email@example.com"},"address":{"$ref":"#/components/schemas/Address"},"period":{"type":"string","description":"How frequently you want to be billed","example":"MONTHLY","enum":["MONTHLY","QUARTERLY","SEMIANNUALLY","ANNUALLY","BIENNIALLY"]},"currency":{"type":"string","description":"The currency code of the currency you want to pay in","example":"GBP","enum":["GBP","EUR","USD","AUD","CAD"]},"nextBillingDate":{"type":"string","format":"date-time","description":"The datetime the next invoice for the subscription will be sent","example":"2021-02-17T09:24:01.417Z"},"amount":{"$ref":"#/components/schemas/Amount"}}}},"components/schemas/Coupon":{"id":"components/schemas/Coupon","kind":"json-schema","title":"Coupon","data":{"type":"object","required":["id","name","discountPercentage","status"],"properties":{"id":{"type":"string","description":"The ID of the coupon","example":"5%OFF-COUPON"},"name":{"type":"string","description":"The name of the coupon","example":"5% off coupon"},"discountPercentage":{"type":"number","format":"double","description":"The percentage discount given by the coupon","example":12.5},"status":{"type":"string","description":"The status of the coupon","example":"ACTIVE","enum":["ACTIVE","EXPIRED","ARCHIVED","DELETED"]}}}},"components/schemas/SignupUser":{"id":"components/schemas/SignupUser","kind":"json-schema","title":"SignupUser","data":{"type":"object","required":["email"],"properties":{"email":{"type":"string","description":"Email of the user who is signing up","example":"some@email.com"},"name":{"type":"string","nullable":true,"description":"Name of the user who is signing up","example":"Some Name"}}}},"components/schemas/CreatedSubscription":{"id":"components/schemas/CreatedSubscription","kind":"json-schema","title":"CreatedSubscription","data":{"type":"object","required":["type","accountId","startDate","plan","companyName","billing","coupons","signupUser"],"properties":{"type":{"type":"string","enum":["CREATED"]},"accountId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Subscription"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is for"},"children":[]}]}]}],"type":"string","example":"cfb665ca-ce35-4418-b9d5-70ee815db4bd"},"startDate":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The datetime the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Subscription"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" started in ISO datetime format"},"children":[]}]}]}],"example":"2021-02-17T09:24:01.417Z"},"companyName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The company name of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Subscription"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]}]}]}]}],"type":"string","nullable":true,"example":"Acme Inc."},"plan":{"$ref":"#/components/schemas/Plan"},"billing":{"$ref":"#/components/schemas/Billing"},"coupons":{"type":"array","items":{"$ref":"#/components/schemas/Coupon"}},"signupUser":{"$ref":"#/components/schemas/SignupUser"}}}},"components/schemas/PendingSubscription":{"id":"components/schemas/PendingSubscription","kind":"json-schema","title":"PendingSubscription","data":{"type":"object","required":["type","accountId","setupIntentId"],"properties":{"type":{"type":"string","enum":["PENDING"]},"accountId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Subscription"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is for"},"children":[]}]}]}],"type":"string","example":"cfb665ca-ce35-4418-b9d5-70ee815db4bd"},"setupIntentId":{"description":"A unique reference to a payment provider's setup intent object","type":"string","example":"some-setup-intent-id"},"subscriptionIntentId":{"description":"A unique reference to a subscription intent object","type":"string","nullable":true,"example":"cfb665ca-ce35-4418-b9d5-70ee815db4bd"}}}},"components/schemas/FailedSubscription":{"id":"components/schemas/FailedSubscription","kind":"json-schema","title":"FailedSubscription","data":{"type":"object","required":["type","accountId","setupIntentId","failure"],"properties":{"type":{"type":"string","enum":["FAILED"]},"accountId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Subscription"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is for"},"children":[]}]}]}],"type":"string","example":"cfb665ca-ce35-4418-b9d5-70ee815db4bd"},"setupIntentId":{"description":"A unique reference to a payment provider's setup intent object","type":"string","example":"some-setup-intent-id"},"subscriptionIntentId":{"description":"A unique reference to a subscription intent object","type":"string","nullable":true,"example":"cfb665ca-ce35-4418-b9d5-70ee815db4bd"},"failure":{"description":"The reason this subscription could not be created","type":"string","example":"This is the reason that the subscription could not be created"}}}},"components/schemas/Subscription":{"id":"components/schemas/Subscription","kind":"json-schema","title":"Subscription","data":{"oneOf":[{"$ref":"#/components/schemas/CreatedSubscription"},{"$ref":"#/components/schemas/PendingSubscription"},{"$ref":"#/components/schemas/FailedSubscription"}],"discriminator":{"propertyName":"type","mapping":{"CREATED":"#/components/schemas/CreatedSubscription","PENDING":"#/components/schemas/PendingSubscription","FAILED":"#/components/schemas/FailedSubscription"}}}},"components/schemas/SubscriptionWithPermittedActions":{"id":"components/schemas/SubscriptionWithPermittedActions","kind":"json-schema","title":"SubscriptionWithPermittedActions","data":{"type":"object","required":["result","permittedActions"],"properties":{"result":{"$ref":"#/components/schemas/Subscription"},"permittedActions":{"type":"array","items":{"$ref":"#/components/schemas/PermittedAction"}}}}},"components/schemas/CreatedSubscriptionWithPermittedActions":{"id":"components/schemas/CreatedSubscriptionWithPermittedActions","kind":"json-schema","title":"CreatedSubscriptionWithPermittedActions","data":{"type":"object","required":["result","permittedActions"],"properties":{"result":{"$ref":"#/components/schemas/CreatedSubscription"},"permittedActions":{"type":"array","items":{"$ref":"#/components/schemas/PermittedAction"}}}}},"components/schemas/TieredValueBasedPlanRequest":{"id":"components/schemas/TieredValueBasedPlanRequest","kind":"json-schema","title":"TieredValueBasedPlanRequest","data":{"type":"object","required":["type","planName","extraAssets"],"properties":{"type":{"type":"string","enum":["TIERED_VALUE_BASED"]},"planName":{"type":"string","example":"STARTUP","enum":["STARTUP","SMALL_TEAM","GROWING_BRAND","ESTABLISHED_BRAND"]},"extraAssets":{"type":"integer","example":1000}}}},"components/schemas/StorageAndDownloadsPlanRequest":{"id":"components/schemas/StorageAndDownloadsPlanRequest","kind":"json-schema","title":"StorageAndDownloadsPlanRequest","data":{"type":"object","required":["type","planName","extraStorageInGb"],"properties":{"type":{"type":"string","enum":["STORAGE_AND_DOWNLOADS"]},"planName":{"type":"string","example":"STARTUP","enum":["STARTUP","SMALL_TEAM","GROWING_BRAND","ESTABLISHED_BRAND"]},"extraStorageInGb":{"type":"integer","example":10}}}},"components/schemas/StorageAndDownloadsV7PlanRequest":{"id":"components/schemas/StorageAndDownloadsV7PlanRequest","kind":"json-schema","title":"StorageAndDownloadsV7PlanRequest","data":{"type":"object","required":["type","planName","extraStorageInGb"],"properties":{"type":{"type":"string","enum":["STORAGE_AND_DOWNLOADS_V7"]},"planName":{"type":"string","example":"STARTUP","enum":["STARTUP","GROWING_BRAND","ESTABLISHED_BRAND","ENTERPRISE"]},"extraStorageInGb":{"type":"integer","example":10}}}},"components/schemas/StorageAndDownloadsV8PlanRequest":{"id":"components/schemas/StorageAndDownloadsV8PlanRequest","kind":"json-schema","title":"StorageAndDownloadsV8PlanRequest","data":{"type":"object","required":["type","planName","extraStorageInGb"],"properties":{"type":{"type":"string","enum":["STORAGE_AND_DOWNLOADS_V8"]},"planName":{"type":"string","example":"STARTUP","enum":["STARTUP","GROWING_BRAND","ESTABLISHED_BRAND","ENTERPRISE"]},"extraStorageInGb":{"type":"integer","example":10}}}},"components/schemas/PlanRequest":{"id":"components/schemas/PlanRequest","kind":"json-schema","title":"PlanRequest","data":{"oneOf":[{"$ref":"#/components/schemas/TieredValueBasedPlanRequest"},{"$ref":"#/components/schemas/StorageAndDownloadsPlanRequest"},{"$ref":"#/components/schemas/StorageAndDownloadsV7PlanRequest"},{"$ref":"#/components/schemas/StorageAndDownloadsV8PlanRequest"}],"discriminator":{"propertyName":"type","mapping":{"TIERED_VALUE_BASED":"#/components/schemas/TieredValueBasedPlanRequest","STORAGE_AND_DOWNLOADS":"#/components/schemas/StorageAndDownloadsPlanRequest","STORAGE_AND_DOWNLOADS_V7":"#/components/schemas/StorageAndDownloadsV7PlanRequest","STORAGE_AND_DOWNLOADS_V8":"#/components/schemas/StorageAndDownloadsV8PlanRequest"}}}},"components/schemas/BillingRequest":{"id":"components/schemas/BillingRequest","kind":"json-schema","title":"BillingRequest","data":{"type":"object","required":["billingPeriod","currency"],"properties":{"billingPeriod":{"type":"string","description":"How frequently you want to be billed","example":"MONTHLY","enum":["MONTHLY","ANNUALLY"]},"currency":{"type":"string","description":"The currency code of the currency you want to pay in","example":"GBP","enum":["GBP","EUR","USD","AUD","CAD"]},"country":{"type":"string","description":"The country code of the billing address","nullable":true,"example":"GB"}}}},"components/schemas/SubscriptionIntentRequest":{"id":"components/schemas/SubscriptionIntentRequest","kind":"json-schema","title":"SubscriptionIntentRequest","data":{"type":"object","required":["planRequest","billingRequest","signupUser","couponIds"],"properties":{"planRequest":{"$ref":"#/components/schemas/PlanRequest","description":"The plan of the subscription you intend to pay for"},"billingRequest":{"$ref":"#/components/schemas/BillingRequest","description":"The billing details of the subscription you intend to pay for"},"signupUser":{"$ref":"#/components/schemas/SignupUser","description":"The details of the user that is signing up"},"couponIds":{"type":"array","description":"The coupon IDs to apply to the subscription you intend to pay for","items":{"type":"string"}}}}},"components/schemas/PendingPaymentStatus":{"id":"components/schemas/PendingPaymentStatus","kind":"json-schema","title":"PendingPaymentStatus","data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["PENDING"]}}}},"components/schemas/ApprovedPaymentStatus":{"id":"components/schemas/ApprovedPaymentStatus","kind":"json-schema","title":"ApprovedPaymentStatus","data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["APPROVED"]}}}},"components/schemas/SucceededPaymentStatus":{"id":"components/schemas/SucceededPaymentStatus","kind":"json-schema","title":"SucceededPaymentStatus","data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["SUCCEEDED"]}}}},"components/schemas/FailedPaymentStatus":{"id":"components/schemas/FailedPaymentStatus","kind":"json-schema","title":"FailedPaymentStatus","data":{"type":"object","required":["type","errorCode","errorText"],"properties":{"type":{"type":"string","enum":["FAILED"]},"errorCode":{"type":"string","description":"The error code received from the payment platform","example":1234},"errorText":{"type":"string","description":"The error message received from the payment platform","example":"Insufficient funds"}}}},"components/schemas/PaymentStatus":{"id":"components/schemas/PaymentStatus","kind":"json-schema","title":"PaymentStatus","data":{"oneOf":[{"$ref":"#/components/schemas/PendingPaymentStatus"},{"$ref":"#/components/schemas/ApprovedPaymentStatus"},{"$ref":"#/components/schemas/SucceededPaymentStatus"},{"$ref":"#/components/schemas/FailedPaymentStatus"}],"discriminator":{"propertyName":"type","mapping":{"PENDING":"#/components/schemas/PendingPaymentStatus","APPROVED":"#/components/schemas/ApprovedPaymentStatus","SUCCEEDED":"#/components/schemas/SucceededPaymentStatus","FAILED":"#/components/schemas/FailedPaymentStatus"}}}},"components/schemas/SubscriptionIntent":{"id":"components/schemas/SubscriptionIntent","kind":"json-schema","title":"SubscriptionIntent","data":{"type":"object","required":["id","setupIntentId","setupIntentClientSecret","accountId","amount","planRequest","billingRequest","signupUser","coupons","paymentStatus"],"properties":{"id":{"type":"string","description":"A unique reference to a subscription intent object","example":"cfb665ca-ce35-4418-b9d5-70ee815db4bd"},"setupIntentId":{"type":"string","description":"A unique reference to a payment provider's setup intent object","example":"some-setup-intent-id"},"setupIntentClientSecret":{"type":"string","description":"The secret used to add a payment method to the setup intent using a payment provider","example":"some-setup-intent-client-secret"},"accountId":{"type":"string","description":"The account ID of the account that this subscription intent belongs to"},"amount":{"$ref":"#/components/schemas/Amount"},"planRequest":{"$ref":"#/components/schemas/PlanRequest","description":"The plan of the subscription you intend to pay for"},"billingRequest":{"$ref":"#/components/schemas/BillingRequest","description":"The billing details of the subscription you intend to pay for"},"signupUser":{"$ref":"#/components/schemas/SignupUser","description":"The details of the user that is signing up"},"coupons":{"type":"array","description":"The coupons to apply to the subscription you intend to pay for","items":{"$ref":"#/components/schemas/Coupon"}},"paymentStatus":{"$ref":"#/components/schemas/PaymentStatus","description":"The status of the payment for the subscription"}}}},"components/schemas/SubscriptionIntentWithPermittedActions":{"id":"components/schemas/SubscriptionIntentWithPermittedActions","kind":"json-schema","title":"SubscriptionIntentWithPermittedActions","data":{"type":"object","required":["result","permittedActions"],"properties":{"result":{"$ref":"#/components/schemas/SubscriptionIntent"},"permittedActions":{"type":"array","items":{"$ref":"#/components/schemas/PermittedAction"}}}}},"components/schemas/SubscriptionIntentPatchRequest":{"id":"components/schemas/SubscriptionIntentPatchRequest","kind":"json-schema","title":"SubscriptionIntentPatchRequest","data":{"type":"object","properties":{"planRequest":{"$ref":"#/components/schemas/PlanRequest","nullable":true,"description":"The plan of the subscription you intend to pay for"},"billingRequest":{"$ref":"#/components/schemas/BillingRequest","nullable":true,"description":"The billing details of the subscription you intend to pay for"},"signupUser":{"$ref":"#/components/schemas/SignupUser","nullable":true,"description":"The details of the user that is signing up"},"couponIds":{"type":"array","nullable":true,"description":"The coupon IDs to apply to the subscription you intend to pay for","items":{"type":"string"}}}}},"components/schemas/DownloadCountInDateRange":{"id":"components/schemas/DownloadCountInDateRange","kind":"json-schema","title":"DownloadCountInDateRange","data":{"type":"object","required":["dateFrom","dateTo","downloadCount"],"properties":{"dateFrom":{"type":"string","format":"date-time","description":"Date downloads are counted from","example":"2024-01-15T00:00:00.000Z"},"dateTo":{"type":"string","format":"date-time","description":"Date downloads are counted to","example":"2024-02-15T00:00:00.000Z"},"downloadCount":{"type":"integer","description":"Number of downloads in this date range","example":15}}}},"components/schemas/DownloadCountsByUserType":{"id":"components/schemas/DownloadCountsByUserType","kind":"json-schema","title":"DownloadCountsByUserType","data":{"type":"object","description":"Download usage in the last month broken down into different categories","required":["downloadsBySignedInUsers","downloadsByPublicVisitors","activeEmbeddableLinks"],"properties":{"downloadsBySignedInUsers":{"type":"integer","description":"Number of downloads by signed-in users in the last month","example":67},"downloadsByPublicVisitors":{"type":"integer","description":"Number of downloads by portal users and share link users in the last month","example":0},"activeEmbeddableLinks":{"type":"integer","description":"Number of currently-active embeddable links","example":15}}}},"components/schemas/SubscriptionUsage":{"id":"components/schemas/SubscriptionUsage","kind":"json-schema","title":"SubscriptionUsage","data":{"type":"object","required":["lastSixMonthsDownloadCountsChronologically","lastMonthDownloadCountsByUserType","storageBytesStored","numberOfAssets"],"properties":{"lastSixMonthsDownloadCountsChronologically":{"type":"array","items":{"$ref":"#/components/schemas/DownloadCountInDateRange"},"minItems":6,"maxItems":6,"description":"Download counts for the last 6 months in chronological order"},"lastMonthDownloadCountsByUserType":{"$ref":"#/components/schemas/DownloadCountsByUserType"},"storageBytesStored":{"type":"integer","description":"Number of bytes of data currently stored","example":7981506322},"numberOfAssets":{"type":"integer","description":"Total number of assets currently in account","example":2540}}}},"components/schemas/EmbeddableLinkPatchRequest":{"id":"components/schemas/EmbeddableLinkPatchRequest","kind":"json-schema","title":"EmbeddableLinkPatchRequest","data":{"type":"object","required":["status"],"properties":{"status":{"type":"string","description":"The status of the AssetEmbeddableLink","enum":["REVOKED"]}}}},"components/schemas/DeterminedTransformation":{"id":"components/schemas/DeterminedTransformation","kind":"json-schema","title":"DeterminedTransformation","data":{"type":"object","required":["transformations"],"properties":{"transformations":{"type":"array","items":{"$ref":"#/components/schemas/Transformation"}}}}},"components/schemas/EmbeddableLink":{"id":"components/schemas/EmbeddableLink","kind":"json-schema","title":"EmbeddableLink","data":{"type":"object","required":["id","accountId","assetId","assetFileId","transformationDescription","determinedTransformation","status","fileStatus","url"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Asset-Embeddable-Links"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetEmbeddableLink"},"children":[]}]}]}]}],"example":"02e3b733-57c0-43f1-bee4-687569cf1bfa"},"accountId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Asset-Embeddable-Links"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetEmbeddableLink"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" belongs to"},"children":[]}]}]}],"type":"string","example":"cfb665ca-ce35-4418-b9d5-70ee815db4bd"},"assetId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Asset-Embeddable-Links"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetEmbeddableLink"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is for"},"children":[]}]}]}],"example":"7af90a8b-7ccd-430f-a85d-e8614015bc47"},"assetFileId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/getassetfiles"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetFile"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Asset-Embeddable-Links"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetEmbeddableLink"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is for"},"children":[]}]}]}],"example":"7af90a8b-7ccd-430f-a85d-e8614015bc47"},"transformationDescription":{"$ref":"#/components/schemas/TransformationDescription"},"determinedTransformation":{"$ref":"#/components/schemas/DeterminedTransformation"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The high level status of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Asset-Embeddable-Links"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetEmbeddableLink"},"children":[]}]}]}]}],"example":"ACTIVE","enum":["PENDING","ACTIVE","FAILED","REVOKE_REQUESTED","REVOKED"]},"fileStatus":{"type":"string","description":"More in depth status on the generation of the file itself","example":"COPIED","enum":["TEMP_FILE_PENDING","TEMP_FILE_FAILED","TEMP_FILE_GENERATED","COPY_PENDING","COPIED","DELETE_PENDING","DELETED"]},"url":{"type":"string","description":"The location of the actual embeddable file","example":"https://link.assetfile.io/3KdYk7kAiPS0kxhOC43krJ/axel-vazquez-5bb6VFLYCCM-unsplash.jpg"}}}},"components/schemas/EmbeddableLinkWithPermittedActions":{"id":"components/schemas/EmbeddableLinkWithPermittedActions","kind":"json-schema","title":"EmbeddableLinkWithPermittedActions","data":{"type":"object","required":["result","permittedActions"],"properties":{"result":{"$ref":"#/components/schemas/EmbeddableLink"},"permittedActions":{"type":"array","items":{"$ref":"#/components/schemas/PermittedAction"}}}}},"components/schemas/EmbeddableLinkDetails":{"id":"components/schemas/EmbeddableLinkDetails","kind":"json-schema","title":"EmbeddableLinkDetails","data":{"type":"object","required":["assetId"],"properties":{"assetId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Assets"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Asset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to create an embeddable link for"},"children":[]}]}]}],"example":"7af90a8b-7ccd-430f-a85d-e8614015bc47"},"assetFileId":{"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 ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/getassetfiles"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetFile"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to create an embeddable link for. If null the current "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/assets/getassetfiles"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetFile"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used."},"children":[]}]}]}],"example":"7af90a8b-7ccd-430f-a85d-e8614015bc47"},"presetParameters":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PresetParameters for this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"assetId"},"children":[]}]}]}],"default":[],"items":{"$ref":"#/components/schemas/PresetParameters"}}}}},"components/schemas/EmbeddableLinkBatchRequestItem":{"id":"components/schemas/EmbeddableLinkBatchRequestItem","kind":"json-schema","title":"EmbeddableLinkBatchRequestItem","data":{"allOf":[{"$ref":"#/components/schemas/BatchItem"},{"$ref":"#/components/schemas/EmbeddableLinkDetails"}]}},"components/schemas/EmbeddableLinkBatchRequest":{"id":"components/schemas/EmbeddableLinkBatchRequest","kind":"json-schema","title":"EmbeddableLinkBatchRequest","data":{"type":"object","required":["items","transformationDescription"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/EmbeddableLinkBatchRequestItem"}},"transformationDescription":{"$ref":"#/components/schemas/TransformationDescription"}}}},"components/schemas/EmbeddableLinkFailure":{"id":"components/schemas/EmbeddableLinkFailure","kind":"json-schema","title":"EmbeddableLinkFailure","data":{"type":"string","enum":["INVALID","FORBIDDEN","FAILURE"]}},"components/schemas/EmbeddableLinkBatch":{"id":"components/schemas/EmbeddableLinkBatch","kind":"json-schema","title":"EmbeddableLinkBatch","data":{"type":"object","required":["results","failures"],"properties":{"results":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A map of results keyed on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"batchItemId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" provided in the request"},"children":[]}]}]}],"additionalProperties":{"$ref":"#/components/schemas/EmbeddableLinkWithPermittedActions"}},"failures":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A map of failures keyed on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"batchItemId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" provided in the request"},"children":[]}]}]}],"additionalProperties":{"$ref":"#/components/schemas/EmbeddableLinkFailure"}}}}},"components/schemas/EmbeddableLinkBatchCompletedJob":{"id":"components/schemas/EmbeddableLinkBatchCompletedJob","kind":"json-schema","title":"EmbeddableLinkBatchCompletedJob","data":{"allOf":[{"$ref":"#/components/schemas/CompletedJob"},{"type":"object","required":["result"],"properties":{"result":{"$ref":"#/components/schemas/EmbeddableLinkBatch"}}}]}},"components/schemas/EmbeddableLinkBatchJob":{"id":"components/schemas/EmbeddableLinkBatchJob","kind":"json-schema","title":"EmbeddableLinkBatchJob","data":{"oneOf":[{"$ref":"#/components/schemas/InProgressJob"},{"$ref":"#/components/schemas/EmbeddableLinkBatchCompletedJob"},{"$ref":"#/components/schemas/FailedJob"}],"discriminator":{"propertyName":"type","mapping":{"IN_PROGRESS":"#/components/schemas/InProgressJob","COMPLETED":"#/components/schemas/EmbeddableLinkBatchCompletedJob","FAILED":"#/components/schemas/FailedJob"}}}},"components/schemas/EmbeddableLinkSearchField":{"id":"components/schemas/EmbeddableLinkSearchField","kind":"json-schema","title":"EmbeddableLinkSearchField","data":{"type":"string","enum":["ASSET_ID"],"example":"ASSET_ID","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Asset-Embeddable-Links"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetEmbeddableLink"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property value to search by"},"children":[]}]}]}]}},"components/schemas/EmbeddableLinkFieldInSearchCriterion":{"id":"components/schemas/EmbeddableLinkFieldInSearchCriterion","kind":"json-schema","title":"EmbeddableLinkFieldInSearchCriterion","data":{"allOf":[{"$ref":"#/components/schemas/FieldInSearchCriterion"},{"type":"object","required":["type","field"],"properties":{"type":{"type":"string","enum":["FIELD_IN"]},"field":{"$ref":"#/components/schemas/EmbeddableLinkSearchField"}}}]}},"components/schemas/EmbeddableLinkSearchCriterion":{"id":"components/schemas/EmbeddableLinkSearchCriterion","kind":"json-schema","title":"EmbeddableLinkSearchCriterion","data":{"oneOf":[{"$ref":"#/components/schemas/EmbeddableLinkFieldInSearchCriterion"}],"discriminator":{"propertyName":"type","mapping":{"FIELD_IN":"#/components/schemas/EmbeddableLinkFieldInSearchCriterion"}}}},"components/schemas/EmbeddableLinkSortField":{"id":"components/schemas/EmbeddableLinkSortField","kind":"json-schema","title":"EmbeddableLinkSortField","data":{"type":"string","enum":["ASSET_ID"],"example":"ASSET_ID","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Asset-Embeddable-Links"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EmbeddableLink"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property value to sort by"},"children":[]}]}]}]}},"components/schemas/EmbeddableLinkSort":{"id":"components/schemas/EmbeddableLinkSort","kind":"json-schema","title":"EmbeddableLinkSort","data":{"type":"object","properties":{"field":{"$ref":"#/components/schemas/EmbeddableLinkSortField"},"order":{"$ref":"#/components/schemas/SortOrder"}}}},"components/schemas/EmbeddableLinkSearchRequest":{"id":"components/schemas/EmbeddableLinkSearchRequest","kind":"json-schema","title":"EmbeddableLinkSearchRequest","data":{"allOf":[{"$ref":"#/components/schemas/BasePaginatedSearchInAccountRequest"},{"type":"object","properties":{"criterion":{"description":"The search criterion","$ref":"#/components/schemas/EmbeddableLinkSearchCriterion"},"sorts":{"description":"Sorts to be applied to the search in order of precedence","type":"array","items":{"$ref":"#/components/schemas/EmbeddableLinkSort"}}}}]}},"components/schemas/EmbeddableLinkSearch":{"id":"components/schemas/EmbeddableLinkSearch","kind":"json-schema","title":"EmbeddableLinkSearch","data":{"type":"object","properties":{"results":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The specified page of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Asset-Embeddable-Links"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetEmbeddableLink"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources which match the search criterion"},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/EmbeddableLinkWithPermittedActions"}},"totalResults":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total number of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/Asset-Embeddable-Links"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AssetEmbeddableLink"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources which match the search criterion"},"children":[]}]}]}],"example":15}}}},"components/schemas/PlatformUserRequest":{"id":"components/schemas/PlatformUserRequest","kind":"json-schema","title":"PlatformUserRequest","data":{"type":"object","required":["email","password"],"properties":{"email":{"description":"The email address of the new user","type":"string","example":"ken.hasselback@gmail.com"},"password":{"description":"The password of the new user","type":"string","example":"password"},"firstName":{"nullable":true,"description":"The first name of the new user","type":"string","example":"Ken"},"lastName":{"nullable":true,"description":"The last name of the new user","type":"string","example":"Hasselback"}}}},"components/schemas/PlatformUserPatchRequest":{"id":"components/schemas/PlatformUserPatchRequest","kind":"json-schema","title":"PlatformUserPatchRequest","data":{"type":"object","properties":{"firstName":{"nullable":true,"description":"The updated first name of the user","type":"string","example":"Bob"},"lastName":{"nullable":true,"description":"The updated last name of the user","type":"string","example":"Syurunkl"}}}},"components/schemas/PlatformUserProfilePictureUploadRequest":{"id":"components/schemas/PlatformUserProfilePictureUploadRequest","kind":"json-schema","title":"PlatformUserProfilePictureUploadRequest","data":{"type":"object","required":["contentType"],"properties":{"contentType":{"description":"The image content type of the profile picture to upload","type":"string","example":"image/png"}}}},"components/schemas/PlatformUserProfilePictureUpload":{"id":"components/schemas/PlatformUserProfilePictureUpload","kind":"json-schema","title":"PlatformUserProfilePictureUpload","data":{"type":"object","required":["uploadUrl","pictureUrl"],"properties":{"uploadUrl":{"description":"The URL that can be used to upload the profile picture","type":"string","example":"https://example.com/profile-picture-upload"},"pictureUrl":{"description":"The URL to store against the platform user profile picture after upload","type":"string","example":"https://example.com/profile-picture.jpg"}}}},"components/schemas/PlatformUserProfilePictureRequest":{"id":"components/schemas/PlatformUserProfilePictureRequest","kind":"json-schema","title":"PlatformUserProfilePictureRequest","data":{"type":"object","required":["pictureUrl"],"properties":{"pictureUrl":{"description":"The URL of the profile picture to store against the platform user","type":"string","example":"https://example.com/profile-picture.jpg"}}}},"components/schemas/PlatformCurrentUserAccountSearchRequest":{"id":"components/schemas/PlatformCurrentUserAccountSearchRequest","kind":"json-schema","title":"PlatformCurrentUserAccountSearchRequest","data":{"type":"object","properties":{"from":{"description":"The item number to begin the result set from","type":"integer","example":0,"default":0},"pageSize":{"description":"The maximum number of items to return in the result set.","type":"integer","minimum":0,"maximum":1000,"example":100,"default":100}}}},"components/schemas/PlatformUserForgottenPasswordRequest":{"id":"components/schemas/PlatformUserForgottenPasswordRequest","kind":"json-schema","title":"PlatformUserForgottenPasswordRequest","data":{"type":"object","required":["email"],"properties":{"email":{"description":"The email address to send the password reset to","type":"string","example":"john.smith@gmail.com"}}}},"components/schemas/PlatformUserResetPasswordRequest":{"id":"components/schemas/PlatformUserResetPasswordRequest","kind":"json-schema","title":"PlatformUserResetPasswordRequest","data":{"type":"object","required":["userId","password"],"properties":{"userId":{"description":"The id of the user to reset the password for","type":"string","example":"john.smith@gmail.com"},"password":{"description":"The new password","type":"string","example":"password2"}}}},"components/schemas/PlatformUserSignUpTokenRequest":{"id":"components/schemas/PlatformUserSignUpTokenRequest","kind":"json-schema","title":"PlatformUserSignUpTokenRequest","data":{"type":"object","required":["email","activationCode"],"properties":{"email":{"description":"The email address that the token should allow sign-up for","type":"string","example":"john.smith@gmail.com"},"verificationCode":{"description":"The  code which confirms the caller is verified owner of the supplied email address","type":"string"}}}},"components/schemas/PlatformUserSignUpToken":{"id":"components/schemas/PlatformUserSignUpToken","kind":"json-schema","title":"PlatformUserSignUpToken","data":{"type":"object","required":["token"],"properties":{"token":{"description":"The authentication token to be used to complete sign-up","type":"string"}}}},"components/schemas/PlatformUserVerificationRequest":{"id":"components/schemas/PlatformUserVerificationRequest","kind":"json-schema","title":"PlatformUserVerificationRequest","data":{"type":"object","required":["email"],"properties":{"email":{"description":"The email address to send the verification code to","type":"string","example":"john.smith@gmail.com"}}}},"components/schemas/EntityQuotaOverride":{"id":"components/schemas/EntityQuotaOverride","kind":"json-schema","title":"EntityQuotaOverride","data":{"type":"object","required":["id","accountId","entityName","quota"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/EntityQuotaOverride"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EntityQuotaOverride"},"children":[]}]}]}]}],"example":"18214033-c6b0-4e53-be89-3eca66297c5d"},"accountId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/dash/openapi/EntityQuotaOverride"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EntityQuotaOverride"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" belongs to"},"children":[]}]}]}],"type":"string","example":"cfb665ca-ce35-4418-b9d5-70ee815db4bd"},"entityName":{"type":"string","description":"The name of the entity that is having its quota overridden for this account","example":"USER"},"quota":{"type":"number","description":"The entity's new quota amount for this account","example":5000}}}},"components/schemas/EntityQuotaOverrideWithPermittedActions":{"id":"components/schemas/EntityQuotaOverrideWithPermittedActions","kind":"json-schema","title":"EntityQuotaOverrideWithPermittedActions","data":{"type":"object","required":["result","permittedActions"],"properties":{"result":{"$ref":"#/components/schemas/EntityQuotaOverride"},"permittedActions":{"type":"array","items":{"$ref":"#/components/schemas/PermittedAction"}}}}},"components/schemas/EntityQuotaOverrideRequest":{"id":"components/schemas/EntityQuotaOverrideRequest","kind":"json-schema","title":"EntityQuotaOverrideRequest","data":{"type":"object","required":["quota"],"properties":{"quota":{"type":"number","description":"The entity's new quota amount for this account","example":5000}}}},"components/schemas/ShopifyProductSearchField":{"id":"components/schemas/ShopifyProductSearchField","kind":"json-schema","title":"ShopifyProductSearchField","data":{"type":"string","enum":["SKU"],"example":"SKU","description":"The name of the Shopify Product property value"}},"components/schemas/ShopifyProductFieldInSearchCriterion":{"id":"components/schemas/ShopifyProductFieldInSearchCriterion","kind":"json-schema","title":"ShopifyProductFieldInSearchCriterion","data":{"allOf":[{"$ref":"#/components/schemas/FieldInSearchCriterion"},{"type":"object","required":["type","field"],"properties":{"type":{"type":"string","enum":["FIELD_IN"]},"field":{"$ref":"#/components/schemas/ShopifyProductSearchField"}}}]}},"components/schemas/ShopifyProductSearchCriterion":{"id":"components/schemas/ShopifyProductSearchCriterion","kind":"json-schema","title":"ShopifyProductSearchCriterion","data":{"oneOf":[{"$ref":"#/components/schemas/ShopifyProductFieldInSearchCriterion"}],"discriminator":{"propertyName":"type","mapping":{"FIELD_IN":"#/components/schemas/ShopifyProductFieldInSearchCriterion"}}}},"components/schemas/ShopifyProductSearchRequest":{"id":"components/schemas/ShopifyProductSearchRequest","kind":"json-schema","title":"ShopifyProductSearchRequest","data":{"type":"object","required":["shop","shopifyAccessToken","criterion","pageSize"],"properties":{"shop":{"type":"string","description":"The shop to search within","example":"planto.myshopify.com"},"shopifyAccessToken":{"type":"string","description":"An access token obtained for the above Shopify store that will be used to make requests to Shopify with","example":"cjuqb_6bp89123d45516c78288f433bd8bc13j"},"criterion":{"$ref":"#/components/schemas/ShopifyProductSearchCriterion"},"pageSize":{"description":"The maximum number of items to return in the result set.","type":"integer","minimum":0,"maximum":1000,"example":100},"cursor":{"type":"string","nullable":true,"description":"The position to start the search results from.  Starts from the start if no value provided","example":"eyJsYXN0X2lkIjo3MDE3MjQ0MDY1ODQ4LCJsYXN0X3ZhbHVlIjoiNzAxNzI0NDA2NTg0OCJ9"}}}},"components/schemas/ShopifyProductMedia":{"id":"components/schemas/ShopifyProductMedia","kind":"json-schema","title":"ShopifyProductMedia","data":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The ID of the media in Shopify","example":5692493762034},"previewUrl":{"type":"string","nullable":true,"description":"A URL that provides a preview image of the media","example":"https://example.com/preview"},"duration":{"type":"integer","nullable":true,"description":"The duration of the media in milliseconds, if it has one","example":60000}}}},"components/schemas/ShopifyProduct":{"id":"components/schemas/ShopifyProduct","kind":"json-schema","title":"ShopifyProduct","data":{"type":"object","required":["id","title","handle","media","skus"],"properties":{"id":{"type":"string","description":"The ID of the product in Shopify","example":7693497762034},"title":{"type":"string","description":"The title shown on the product page","example":"Sol classic tee"},"handle":{"type":"string","description":"The no-spaces-allowed-but-still-human-readable identifier of the product","example":"mens-premium-cotton-tshirt-1"},"media":{"type":"array","items":{"$ref":"#/components/schemas/ShopifyProductMedia"}},"skus":{"type":"array","description":"The list of SKUs associated with the product","items":{"type":"string"}}}}},"components/schemas/ShopifyProductWithPermittedActions":{"id":"components/schemas/ShopifyProductWithPermittedActions","kind":"json-schema","title":"ShopifyProductWithPermittedActions","data":{"type":"object","required":["result","permittedActions"],"properties":{"result":{"$ref":"#/components/schemas/ShopifyProduct"},"permittedActions":{"type":"array","items":{"$ref":"#/components/schemas/PermittedAction"}}}}},"components/schemas/ShopifyProductSearch":{"id":"components/schemas/ShopifyProductSearch","kind":"json-schema","title":"ShopifyProductSearch","data":{"type":"object","required":["results"],"properties":{"results":{"type":"array","description":"The specified page of Shopify Product resources which match the search criterion","items":{"$ref":"#/components/schemas/ShopifyProductWithPermittedActions"}},"nextCursor":{"type":"string","nullable":true,"description":"The cursor to feed back into the next search request to get the next page of results.  Null if there are no more results","example":"eyJsYXN0X2lkIjo3MDE3MjQ0MDY1ODQ4LCJsYXN0X3ZhbHVlIjoiNzAxNzI0NDA2NTg0OCJ9"}}}},"components/schemas/ShopifyProductIdSearchRequest":{"id":"components/schemas/ShopifyProductIdSearchRequest","kind":"json-schema","title":"ShopifyProductIdSearchRequest","data":{"type":"object","required":["shop","shopifyAccessToken","dashProductIds"],"properties":{"shop":{"type":"string","description":"The shop to search within","example":"planto.myshopify.com"},"shopifyAccessToken":{"type":"string","description":"An access token obtained for the above Shopify store that will be used to make requests to Shopify with","example":"cjuqb_6bp89123d45516c78288f433bd8bc13j"},"dashProductIds":{"type":"array","minItems":1,"maxItems":250,"description":"Between 1 and 250 Dash product IDs whose stored Shopify product mappings should be searched","items":{"type":"string"}}}}},"components/schemas/ShopifyProductIdSearchResult":{"id":"components/schemas/ShopifyProductIdSearchResult","kind":"json-schema","title":"ShopifyProductIdSearchResult","data":{"type":"object","required":["dashProductId","product"],"properties":{"dashProductId":{"type":"string","description":"The Dash product ID from the search request that resolved to this Shopify product"},"product":{"$ref":"#/components/schemas/ShopifyProductWithPermittedActions"}}}},"components/schemas/ShopifyProductIdSearch":{"id":"components/schemas/ShopifyProductIdSearch","kind":"json-schema","title":"ShopifyProductIdSearch","data":{"type":"object","required":["results"],"properties":{"results":{"type":"array","description":"The resolved Shopify products, each paired with the Dash product ID that produced it. Dash product IDs that cannot be resolved are omitted.","items":{"$ref":"#/components/schemas/ShopifyProductIdSearchResult"}}}}},"components/schemas/AlterShopifyStoreRequestDelete":{"id":"components/schemas/AlterShopifyStoreRequestDelete","kind":"json-schema","title":"AlterShopifyStoreRequestDelete","data":{"type":"object","required":["type","shopifyDomain"],"properties":{"type":{"type":"string","enum":["DELETE"]},"shopifyDomain":{"type":"string","example":"slurm.myshopify.com"}}}},"components/schemas/AlterShopifyStoreRequestInstallRequested":{"id":"components/schemas/AlterShopifyStoreRequestInstallRequested","kind":"json-schema","title":"AlterShopifyStoreRequestInstallRequested","data":{"type":"object","required":["type","shopifyDomain"],"properties":{"type":{"type":"string","enum":["INSTALL_REQUESTED"]},"shopifyDomain":{"type":"string","example":"slurm.myshopify.com"},"setToSync":{"type":"boolean"}}}},"components/schemas/AlterShopifyStoreRequestReadyToInstall":{"id":"components/schemas/AlterShopifyStoreRequestReadyToInstall","kind":"json-schema","title":"AlterShopifyStoreRequestReadyToInstall","data":{"type":"object","required":["type","shopifyDomain","setToSync","installLink"],"properties":{"type":{"type":"string","enum":["READY_TO_INSTALL"]},"shopifyDomain":{"type":"string","example":"slurm.myshopify.com"},"setToSync":{"type":"boolean"},"installLink":{"type":"string"},"connectionPayload":{"type":"object","nullable":true}}}},"components/schemas/AlterShopifyStoreRequestInstalledBeforeProductSync":{"id":"components/schemas/AlterShopifyStoreRequestInstalledBeforeProductSync","kind":"json-schema","title":"AlterShopifyStoreRequestInstalledBeforeProductSync","data":{"type":"object","required":["type","shopifyDomain","setToSync"],"properties":{"type":{"type":"string","enum":["INSTALLED_BEFORE_PRODUCT_SYNC"]},"shopifyDomain":{"type":"string","example":"slurm.myshopify.com"},"setToSync":{"type":"boolean"},"connectionPayload":{"type":"object","nullable":true}}}},"components/schemas/AlterShopifyStoreRequest":{"id":"components/schemas/AlterShopifyStoreRequest","kind":"json-schema","title":"AlterShopifyStoreRequest","data":{"oneOf":[{"$ref":"#/components/schemas/AlterShopifyStoreRequestDelete"},{"$ref":"#/components/schemas/AlterShopifyStoreRequestInstallRequested"},{"$ref":"#/components/schemas/AlterShopifyStoreRequestReadyToInstall"},{"$ref":"#/components/schemas/AlterShopifyStoreRequestInstalledBeforeProductSync"}],"discriminator":{"propertyName":"type","mapping":{"DELETE":"#/components/schemas/AlterShopifyStoreRequestDelete","INSTALL_REQUESTED":"#/components/schemas/AlterShopifyStoreRequestInstallRequested","READY_TO_INSTALL":"#/components/schemas/AlterShopifyStoreRequestReadyToInstall","INSTALLED_BEFORE_PRODUCT_SYNC":"#/components/schemas/AlterShopifyStoreRequestInstalledBeforeProductSync"}}}},"components/schemas/AllowedLoginMethods":{"id":"components/schemas/AllowedLoginMethods","kind":"json-schema","title":"AllowedLoginMethods","data":{"type":"array","description":"The allowed login methods for the account","items":{"$ref":"#/components/schemas/LoginMethod"}}},"components/schemas/AccountTermsAndConditions":{"id":"components/schemas/AccountTermsAndConditions","kind":"json-schema","title":"AccountTermsAndConditions","data":{"type":"object","required":["id","url"],"properties":{"id":{"type":"string","description":"The id of the terms and conditions","example":"v12"},"url":{"type":"string","description":"The URL to the terms and conditions document","example":"https://signup.dash.app/resources/legal/terms-v12.pdf"}}}},"components/schemas/AccountTermsAndConditionsRequest":{"id":"components/schemas/AccountTermsAndConditionsRequest","kind":"json-schema","title":"AccountTermsAndConditionsRequest","data":{"type":"object","properties":{"dateOfEffect":{"type":"string","description":"The datetime the terms come into effect","example":"2025-12-23T00:00:00.001Z","default":"NOW()"},"paidPlansShouldReaccept":{"type":"boolean","description":"Whether accounts on paid plans should be asked to reaccept these new terms","default":false},"reacceptPath":{"type":"string","description":"The path on the frontend app to send the user to reaccept. If null the default /account-terms-and-conditions route will be used.","example":"/account-terms-and-conditions-demerger","nullable":true,"default":null}}}},"schema_25":{"kind":"json-schema","data":{"type":"string"},"id":"schema_25"},"schema_26":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/SearchFilterWithPermittedActions"}},"id":"schema_26"},"schema_27":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/AssetFileWithPermittedActions"}},"id":"schema_27"},"schema_28":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/CommentWithPermittedActions"}},"id":"schema_28"},"schema_29":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/SavedCropAreaSummaryWithPermittedActions"}},"id":"schema_29"},"schema_30":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/CloudConnectionWithPermittedActions"}},"id":"schema_30"},"schema_31":{"kind":"json-schema","data":{"type":"string","enum":["DROPBOX","GOOGLE"]},"id":"schema_31"},"schema_32":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/CloudImportJobWithPermittedActions"}},"id":"schema_32"},"schema_33":{"kind":"json-schema","data":{"type":"object","properties":{"Access-Control-Allow-Origin":{"type":"string"}}},"id":"schema_33"},"schema_34":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/FieldWithPermittedActions"}},"id":"schema_34"},"schema_35":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/FieldViewWithPermittedActions"}},"id":"schema_35"},"schema_36":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/ExternalAppAccountWithPermittedActions"}},"id":"schema_36"},"schema_37":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/ShopifyInstallWithPermittedActions"}},"id":"schema_37"},"schema_38":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/ShopifyExportJobWithPermittedActions"}},"id":"schema_38"},"schema_39":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/StaffMember"}},"id":"schema_39"}},"exampleStore":{"paths/~1preset-transformation-searches/post/requestBody/content/application~1json/examples/Search for non-crop presets that can be used with specified set of assets":{"value":{"from":0,"pageSize":100,"criterion":{"type":"AND","criteria":[{"type":"APPLICABLE_FOR_ANY_ASSETS","assetIds":["2b746f61-d36d-4627-a547-936f6f20594b"]},{"type":"NOT","criterion":{"type":"HAS_TRANSFORMATION_OF_TYPE","transformationType":"CROP"}}]},"sorts":[]},"key":"Search for non-crop presets that can be used with specified set of assets","summary":"Search for non-crop presets that can be used with specified set of assets","id":"paths/~1preset-transformation-searches/post/requestBody/content/application~1json/examples/Search for non-crop presets that can be used with specified set of assets"},"paths/~1preset-transformation-searches/post/responses/200/content/application~1json/examples/Search for non-crop presets that can be used with specified set of assets":{"value":{"results":[{"result":{"id":"a060635d-5807-4115-a2ed-f0588d47e7ba","accountId":"cfb665ca-ce35-4418-b9d5-70ee815db4bd","name":"Medium","position":1,"candidatePresetTransformations":[{"criteria":[{"type":"MATCHES_MEDIA_TYPES","mediaTypes":[{"type":"image","subType":"*"},{"type":"application","subType":"psd"}]},{"type":"IS_TRANSPARENT","isTransparent":true}],"transformationTemplate":[{"type":"RESIZE","width":1200,"height":1200},{"type":"CONVERT","mediaType":{"type":"image","subType":"png"}}]},{"criteria":[{"type":"MATCHES_MEDIA_TYPES","mediaTypes":[{"type":"image","subtype":"*"},{"type":"application","subtype":"psd"}]},{"type":"IS_TRANSPARENT","isTransparent":false}],"transformationTemplate":[{"type":"RESIZE","width":1200,"height":1200},{"type":"CONVERT","mediaType":{"type":"image","subType":"jpeg"}}]}]},"permittedActions":[]},{"result":{"id":"917087a6-8f76-4e77-be14-1ac637637c69","accountId":"cfb665ca-ce35-4418-b9d5-70ee815db4bd","name":"Large","position":2,"candidatePresetTransformations":[{"criteria":[{"type":"MATCHES_MEDIA_TYPES","mediaTypes":[{"type":"image","subType":"*"},{"type":"application","subType":"psd"}]},{"type":"IS_TRANSPARENT","isTransparent":true}],"transformationTemplate":[{"type":"RESIZE","width":1200,"height":1200},{"type":"CONVERT","mediaType":{"type":"image","subType":"png"}}]},{"criteria":[{"type":"MATCHES_MEDIA_TYPES","mediaTypes":["image/*","application/psd"]},{"type":"IS_TRANSPARENT","isTransparent":false}],"transformationTemplate":[{"type":"RESIZE","width":2500,"height":2500},{"type":"CONVERT","mediaType":{"type":"image","subType":"jpeg"}}]}]},"permittedActions":[]}],"totalResults":2},"key":"Search for non-crop presets that can be used with specified set of assets","summary":"Search for non-crop presets that can be used with specified set of assets","id":"paths/~1preset-transformation-searches/post/responses/200/content/application~1json/examples/Search for non-crop presets that can be used with specified set of assets"},"paths/~1search-filter-view/get/responses/200/content/application~1json/examples/View":{"value":{"accountId":"cfb665ca-ce35-4418-b9d5-70ee815db4bd","searchFilters":[{"type":"FIELD","id":"502d1473-f047-4a2c-9885-16274e4407b9","accountId":"cfb665ca-ce35-4418-b9d5-70ee815db4bd","fieldId":"88eb1aca-cf98-4e87-9165-33e7be8b1ea1","allowEmpty":true},{"type":"HARD_CODED_FIXED_OPTION","id":"cb8ad3d9-0c26-4f0e-9884-585d24a86d59","accountId":"cfb665ca-ce35-4418-b9d5-70ee815db4bd","searchField":"FILE_TYPE","allowEmpty":false,"name":"File Type","options":["Image","Video","Audio","Document","Other"]},{"type":"HARD_CODED_FREE_OPTION","id":"5c02e3a0-57f2-4576-b41c-a0a4e30688bd","accountId":"cfb665ca-ce35-4418-b9d5-70ee815db4bd","searchField":"DATE_LIVE","name":"Date Added","dataType":"DATE_TIME","allowEmpty":false},{"type":"HARD_CODED_USER","id":"246b1496-61d3-4b23-ad8e-d6dc990e9ef6","accountId":"cfb665ca-ce35-4418-b9d5-70ee815db4bd","searchField":"STAGED_BY","name":"Added by","allowEmpty":false}]},"key":"View","summary":"View","id":"paths/~1search-filter-view/get/responses/200/content/application~1json/examples/View"},"paths/~1search-filter-view~1search-filters/post/responses/200/content/application~1json/examples/View":{"value":{"accountId":"cfb665ca-ce35-4418-b9d5-70ee815db4bd","searchFilters":[{"type":"FIELD","id":"502d1473-f047-4a2c-9885-16274e4407b9","accountId":"cfb665ca-ce35-4418-b9d5-70ee815db4bd","fieldId":"88eb1aca-cf98-4e87-9165-33e7be8b1ea1","allowEmpty":true},{"type":"HARD_CODED_FIXED_OPTION","id":"cb8ad3d9-0c26-4f0e-9884-585d24a86d59","accountId":"cfb665ca-ce35-4418-b9d5-70ee815db4bd","searchField":"FILE_TYPE","allowEmpty":false,"name":"File Type","options":["Image","Video","Audio","Document","Other"]},{"type":"HARD_CODED_FREE_OPTION","id":"5c02e3a0-57f2-4576-b41c-a0a4e30688bd","accountId":"cfb665ca-ce35-4418-b9d5-70ee815db4bd","searchField":"DATE_LIVE","name":"Date Added","dataType":"DATE_TIME","allowEmpty":false},{"type":"HARD_CODED_USER","id":"246b1496-61d3-4b23-ad8e-d6dc990e9ef6","accountId":"cfb665ca-ce35-4418-b9d5-70ee815db4bd","searchField":"STAGED_BY","name":"Added by","allowEmpty":false}]},"key":"View","summary":"View","id":"paths/~1search-filter-view~1search-filters/post/responses/200/content/application~1json/examples/View"},"paths/~1search-filter-view~1search-filters~1{id}/patch/responses/200/content/application~1json/examples/View":{"value":{"accountId":"cfb665ca-ce35-4418-b9d5-70ee815db4bd","searchFilters":[{"type":"FIELD","id":"502d1473-f047-4a2c-9885-16274e4407b9","accountId":"cfb665ca-ce35-4418-b9d5-70ee815db4bd","fieldId":"88eb1aca-cf98-4e87-9165-33e7be8b1ea1","allowEmpty":true},{"type":"HARD_CODED_FIXED_OPTION","id":"cb8ad3d9-0c26-4f0e-9884-585d24a86d59","accountId":"cfb665ca-ce35-4418-b9d5-70ee815db4bd","searchField":"FILE_TYPE","allowEmpty":false,"name":"File Type","options":["Image","Video","Audio","Document","Other"]},{"type":"HARD_CODED_FREE_OPTION","id":"5c02e3a0-57f2-4576-b41c-a0a4e30688bd","accountId":"cfb665ca-ce35-4418-b9d5-70ee815db4bd","searchField":"DATE_LIVE","name":"Date Added","dataType":"DATE_TIME","allowEmpty":false},{"type":"HARD_CODED_USER","id":"246b1496-61d3-4b23-ad8e-d6dc990e9ef6","accountId":"cfb665ca-ce35-4418-b9d5-70ee815db4bd","searchField":"STAGED_BY","name":"Added by","allowEmpty":false}]},"key":"View","summary":"View","id":"paths/~1search-filter-view~1search-filters~1{id}/patch/responses/200/content/application~1json/examples/View"},"paths/~1search-filter-view~1search-filters~1{id}/delete/responses/200/content/application~1json/examples/View":{"value":{"accountId":"cfb665ca-ce35-4418-b9d5-70ee815db4bd","searchFilters":[{"type":"FIELD","id":"502d1473-f047-4a2c-9885-16274e4407b9","accountId":"cfb665ca-ce35-4418-b9d5-70ee815db4bd","fieldId":"88eb1aca-cf98-4e87-9165-33e7be8b1ea1","allowEmpty":true},{"type":"HARD_CODED_FIXED_OPTION","id":"cb8ad3d9-0c26-4f0e-9884-585d24a86d59","accountId":"cfb665ca-ce35-4418-b9d5-70ee815db4bd","searchField":"FILE_TYPE","allowEmpty":false,"name":"File Type","options":["Image","Video","Audio","Document","Other"]},{"type":"HARD_CODED_FREE_OPTION","id":"5c02e3a0-57f2-4576-b41c-a0a4e30688bd","accountId":"cfb665ca-ce35-4418-b9d5-70ee815db4bd","searchField":"DATE_LIVE","name":"Date Added","dataType":"DATE_TIME","allowEmpty":false},{"type":"HARD_CODED_USER","id":"246b1496-61d3-4b23-ad8e-d6dc990e9ef6","accountId":"cfb665ca-ce35-4418-b9d5-70ee815db4bd","searchField":"STAGED_BY","name":"Added by","allowEmpty":false}]},"key":"View","summary":"View","id":"paths/~1search-filter-view~1search-filters~1{id}/delete/responses/200/content/application~1json/examples/View"},"paths/~1asset-and-upload-batch-jobs~1{id}/get/responses/200/content/application~1json/examples/Completed":{"value":{"id":"be161977-d44e-4888-af3c-66522e223963","accountId":"cfb665ca-ce35-4418-b9d5-70ee815db4bd","creatorId":"google-oauth2|110955770826801837334","type":"COMPLETED","progress":{"steps":[{"id":"assetAndUploadGetJobItemsStep","status":"COMPLETED","completedItems":2,"totalItems":2},{"id":"assetAndUploadProcessJobItemsStep","status":"COMPLETED","completedItems":2,"totalItems":2}]},"dateCompleted":"2021-02-15T09:24:01.417Z","result":{"successes":{"file-1":{"result":{"id":"5a2481e0-819f-4b46-a7e6-143f943345f2","assetId":"7af90a8b-7ccd-430f-a85d-e8614015bc47","uploadParts":[{"partNumber":1,"startByte":0,"endByte":6999999,"url":"https://platform-asset-storage.s3.eu-west-1.amazonaws.com/cfb665ca-ce35-4418-b9d5-70ee815db4bd/7af90a8b-7ccd-430f-a85d-e8614015bc47?uploadId=5a2481e0-819f-4b46-a7e6-143f943345f2&part-number=1"},{"partNumber":"2,","startByte":7000000,"endByte":13999999,"url":"https://platform-asset-storage.s3.eu-west-1.amazonaws.com/cfb665ca-ce35-4418-b9d5-70ee815db4bd7af90a8b-7ccd-430f-a85d-e8614015bc47?uploadId=5a2481e0-819f-4b46-a7e6-143f943345f2&part-number=2"},{"partNumber":3,"startByte":14000000,"endByte":15318361,"url":"https://platform-asset-storage.s3.eu-west-1.amazonaws.com/cfb665ca-ce35-4418-b9d5-70ee815db4bd/7af90a8b-7ccd-430f-a85d-e8614015bc47/?uploadId=5a2481e0-819f-4b46-a7e6-143f943345f2&part-number=3"}]},"permittedActions":[]},"file-2":{"result":{"id":"9f49416e-0813-4930-bf44-a3414ac57938","assetId":"86739a63-a4f3-4655-bd45-7a567379356c","uploadParts":[{"partNumber":1,"startByte":0,"endByte":123456,"url":"https://platform-asset-storage.s3.eu-west-1.amazonaws.com/cfb665ca-ce35-4418-b9d5-70ee815db4bd/86739a63-a4f3-4655-bd45-7a567379356c/86739a63-a4f3-4655-bd45-7a567379356c?uploadId=9f49416e-0813-4930-bf44-a3414ac57938&part-number=1"}]},"permittedActions":[]}}}},"key":"Completed","summary":"Completed","id":"paths/~1asset-and-upload-batch-jobs~1{id}/get/responses/200/content/application~1json/examples/Completed"},"paths/~1asset-upload-batch-jobs~1{id}/get/responses/200/content/application~1json/examples/Completed":{"value":{"id":"be161977-d44e-4888-af3c-66522e223963","accountId":"cfb665ca-ce35-4418-b9d5-70ee815db4bd","creatorId":"google-oauth2|110955770826801837334","type":"COMPLETED","progress":{"steps":[{"id":"assetAndUploadGetJobItemsStep","status":"COMPLETED","completedItems":2,"totalItems":2},{"id":"assetAndUploadProcessJobItemsStep","status":"COMPLETED","completedItems":2,"totalItems":2}]},"dateCompleted":"2021-02-15T09:24:01.417Z","result":{"successes":{"file-1":{"result":{"id":"5a2481e0-819f-4b46-a7e6-143f943345f2","assetId":"7af90a8b-7ccd-430f-a85d-e8614015bc47","uploadParts":[{"partNumber":1,"startByte":0,"endByte":6999999,"url":"https://platform-asset-storage.s3.eu-west-1.amazonaws.com/cfb665ca-ce35-4418-b9d5-70ee815db4bd/7af90a8b-7ccd-430f-a85d-e8614015bc47?uploadId=5a2481e0-819f-4b46-a7e6-143f943345f2&part-number=1"},{"partNumber":"2,","startByte":7000000,"endByte":13999999,"url":"https://platform-asset-storage.s3.eu-west-1.amazonaws.com/cfb665ca-ce35-4418-b9d5-70ee815db4bd7af90a8b-7ccd-430f-a85d-e8614015bc47?uploadId=5a2481e0-819f-4b46-a7e6-143f943345f2&part-number=2"},{"partNumber":3,"startByte":14000000,"endByte":15318361,"url":"https://platform-asset-storage.s3.eu-west-1.amazonaws.com/cfb665ca-ce35-4418-b9d5-70ee815db4bd/7af90a8b-7ccd-430f-a85d-e8614015bc47/?uploadId=5a2481e0-819f-4b46-a7e6-143f943345f2&part-number=3"}]},"permittedActions":[]},"file-2":{"result":{"id":"9f49416e-0813-4930-bf44-a3414ac57938","assetId":"86739a63-a4f3-4655-bd45-7a567379356c","uploadParts":[{"partNumber":1,"startByte":0,"endByte":123456,"url":"https://platform-asset-storage.s3.eu-west-1.amazonaws.com/cfb665ca-ce35-4418-b9d5-70ee815db4bd/86739a63-a4f3-4655-bd45-7a567379356c/86739a63-a4f3-4655-bd45-7a567379356c?uploadId=9f49416e-0813-4930-bf44-a3414ac57938&part-number=1"}]},"permittedActions":[]}}}},"key":"Completed","summary":"Completed","id":"paths/~1asset-upload-batch-jobs~1{id}/get/responses/200/content/application~1json/examples/Completed"},"paths/~1asset-upload-completions/post/requestBody/content/application~1json/examples/Complete 3 parts":{"value":{"uploadId":"5a2481e0-819f-4b46-a7e6-143f943345f2","assetId":"7af90a8b-7ccd-430f-a85d-e8614015bc47","parts":[{"partNumber":1,"eTag":"569726cc-2149-4167-abee-26a068fbda22"},{"partNumber":2,"eTag":"a9398831-2221-4c1f-90e7-b467b926aa16"},{"partNumber":3,"eTag":"820f3b61-3ac7-481c-a6e4-d6c5041683af"}]},"key":"Complete 3 parts","summary":"Complete 3 parts","id":"paths/~1asset-upload-completions/post/requestBody/content/application~1json/examples/Complete 3 parts"},"paths/~1asset-upload-completions/post/responses/200/content/application~1json/examples/Success":{"value":{"result":{"type":"SUCCESS"},"permittedActions":[]},"key":"Success","summary":"Success","id":"paths/~1asset-upload-completions/post/responses/200/content/application~1json/examples/Success"},"paths/~1asset-download-batch-jobs/post/requestBody/content/application~1json/examples/Resize and convert all":{"value":{"items":[{"batchItemId":"download-1","assetId":"2b746f61-d36d-4627-a547-936f6f20594b"},{"batchItemId":"download-2","assetId":"23cfaab7-c9f3-4b28-ac21-7b5b18f2519a"},{"batchItemId":"download-3","assetId":"1ef8108f-6c94-4112-9736-abd147a7a940"}],"transformationDescription":{"type":"CUSTOM","candidateTransformations":[{"criteria":[{"type":"MATCHES_MEDIA_TYPES","mediaTypes":[{"type":"*","subType":"*"}]}],"transformation":[{"type":"RESIZE","width":100,"height":200},{"type":"CONVERT","mediaType":{"type":"image","subType":"jpeg"}}]}]},"zip":true},"key":"Resize and convert all","summary":"Resize and convert all","id":"paths/~1asset-download-batch-jobs/post/requestBody/content/application~1json/examples/Resize and convert all"},"paths/~1asset-download-batch-jobs/post/requestBody/content/application~1json/examples/All untransformed":{"value":{"items":[{"batchItemId":"download-1","assetId":"2b746f61-d36d-4627-a547-936f6f20594b"},{"batchItemId":"download-2","assetId":"23cfaab7-c9f3-4b28-ac21-7b5b18f2519a"},{"batchItemId":"download-3","assetId":"1ef8108f-6c94-4112-9736-abd147a7a940"}],"transformationDescription":{"type":"CUSTOM","candidateTransformations":[{"criteria":[{"type":"MATCHES_MEDIA_TYPES","mediaTypes":[{"type":"*","subType":"*"}]}],"transformation":[]}]},"zip":true},"key":"All untransformed","summary":"All untransformed","id":"paths/~1asset-download-batch-jobs/post/requestBody/content/application~1json/examples/All untransformed"},"paths/~1asset-download-batch-jobs/post/requestBody/content/application~1json/examples/Images as JPGs otherwise untransformed":{"value":{"items":[{"batchItemId":"download-1","assetId":"2b746f61-d36d-4627-a547-936f6f20594b"},{"batchItemId":"download-2","assetId":"23cfaab7-c9f3-4b28-ac21-7b5b18f2519a"},{"batchItemId":"download-3","assetId":"1ef8108f-6c94-4112-9736-abd147a7a940"}],"transformationDescription":{"type":"CUSTOM","candidateTransformations":[{"criteria":{"type":"MATCHES_MEDIA_TYPES","mediaTypes":[{"type":"image","subType":"*"}]},"transformation":[{"type":"CONVERT","mediaType":{"type":"image","subType":"jpeg"}}]},{"criteria":[{"type":"MATCHES_MEDIA_TYPES","mediaTypes":[{"type":"*","subType":"*"}]}],"transformation":[]}]},"zip":true},"key":"Images as JPGs otherwise untransformed","summary":"Images as JPGs otherwise untransformed","id":"paths/~1asset-download-batch-jobs/post/requestBody/content/application~1json/examples/Images as JPGs otherwise untransformed"},"paths/~1asset-download-batch-jobs/post/responses/200/content/application~1json/examples/In progress":{"value":{"id":"be161977-d44e-4888-af3c-66522e223963","accountId":"cfb665ca-ce35-4418-b9d5-70ee815db4bd","creatorId":"google-oauth2|110955770826801837334","type":"IN_PROGRESS","status":"PENDING","progress":{"steps":[{"id":"assetDownloadGetJobItemsStep","status":"STARTED","completedItems":0,"totalItems":0},{"id":"assetDownloadProcessJobItemsStep","status":"PENDING","completedItems":0,"totalItems":0}]}},"key":"In progress","summary":"In progress","id":"paths/~1asset-download-batch-jobs/post/responses/200/content/application~1json/examples/In progress"},"paths/~1asset-download-batch-jobs~1{id}/get/responses/200/content/application~1json/examples/Completed":{"value":{"id":"be161977-d44e-4888-af3c-66522e223963","accountId":"cfb665ca-ce35-4418-b9d5-70ee815db4bd","creatorId":"google-oauth2|110955770826801837334","type":"COMPLETED","progress":{"steps":[{"id":"assetDownloadGetJobItemsStep","status":"COMPLETED","completedItems":3,"totalItems":3},{"id":"assetDownloadProcessJobItemsStep","status":"COMPLETED","completedItems":3,"totalItems":3}]},"dateCompleted":"2021-02-15T09:24:01.417Z","result":{"successes":{"download-1":{"result":{"url":"https://platform-asset-storage.s3.eu-west-1.amazonaws.com/cfb665ca-ce35-4418-b9d5/?signature=dsf78bsdf78"},"permittedActions":[]},"download-2":{"result":{"url":"https://platform-asset-storage.s3.eu-west-1.amazonaws.com/dsasasds-ce35-4418-b9d5/?signature=dsf78bsdf78"},"permittedActions":[]},"download-3":{"result":{"url":"https://platform-asset-storage.s3.eu-west-1.amazonaws.com/dsasasds-ce35-4418dasdasdasd/?signature=dsf78bsdf78"},"permittedActions":[]}},"zipUrl":"https://platform-asset-storage.s3.eu-west-1.amazonaws.com/dsasawadsad418dasdasdasd/?signature=dsf78bsdf78"}},"key":"Completed","summary":"Completed","id":"paths/~1asset-download-batch-jobs~1{id}/get/responses/200/content/application~1json/examples/Completed"},"paths/~1asset-searches/post/requestBody/content/application~1json/examples/Search by field option id":{"value":{"from":0,"pageSize":100,"criterion":{"type":"FIELD_EQUALS","value":"a32fe863-0a1d-4b54-990a-b094139cf81c","field":{"type":"FIELD","fieldId":"a52b5315-15b8-417f-b742-d6902108bac1"}},"sorts":[]},"key":"Search by field option id","summary":"Search by field option id","id":"paths/~1asset-searches/post/requestBody/content/application~1json/examples/Search by field option id"},"paths/~1asset-searches/post/requestBody/content/application~1json/examples/Search by field value":{"value":{"from":0,"pageSize":100,"criterion":{"type":"FIELD_EQUALS","value":"Folder 1","field":{"type":"FIELD","fieldId":"a52b5315-15b8-417f-b742-d6902108bac1"}},"sorts":[]},"key":"Search by field value","summary":"Search by field value","id":"paths/~1asset-searches/post/requestBody/content/application~1json/examples/Search by field value"},"paths/~1asset-searches/post/requestBody/content/application~1json/examples/Search by any field value":{"value":{"from":0,"pageSize":100,"criterion":{"type":"OR","criteria":[{"type":"FIELD_EQUALS","value":"Value 1","field":{"type":"FIELD","fieldId":"a52b5315-15b8-417f-b742-d6902108bac1"}},{"type":"FIELD_EQUALS","value":"Value 2","field":{"type":"FIELD","fieldId":"a52b5315-15b8-417f-b742-d6902108bac1"}},{"type":"FIELD_EQUALS","value":"Value 3","field":{"type":"FIELD","fieldId":"a52b5315-15b8-417f-b742-d6902108bac1"}}]},"sorts":[]},"key":"Search by any field value","summary":"Search by any field value","id":"paths/~1asset-searches/post/requestBody/content/application~1json/examples/Search by any field value"},"paths/~1asset-searches/post/requestBody/content/application~1json/examples/Search for field is empty":{"value":{"from":0,"pageSize":100,"criterion":{"type":"FIELD_IS_EMPTY","field":{"type":"FIELD","fieldId":"a52b5315-15b8-417f-b742-d6902108bac1"}},"sorts":[]},"key":"Search for field is empty","summary":"Search for field is empty","id":"paths/~1asset-searches/post/requestBody/content/application~1json/examples/Search for field is empty"},"paths/~1asset-searches/post/requestBody/content/application~1json/examples/Search by date added range":{"value":{"from":0,"pageSize":100,"criterion":{"type":"FIELD_MATCHES","value":"[2021-01-01 TO 2021-02-01]","field":{"type":"FIXED","fieldName":"DATE_LIVE"}},"sorts":[]},"key":"Search by date added range","summary":"Search by date added range","id":"paths/~1asset-searches/post/requestBody/content/application~1json/examples/Search by date added range"},"paths/~1asset-searches/post/requestBody/content/application~1json/examples/Search by keywords":{"value":{"from":0,"pageSize":100,"criterion":{"type":"FIELD_MATCHES","value":"interesting things","field":{"type":"FIXED","fieldName":"KEYWORDS"}},"sorts":[]},"key":"Search by keywords","summary":"Search by keywords","id":"paths/~1asset-searches/post/requestBody/content/application~1json/examples/Search by keywords"},"paths/~1asset-searches/post/requestBody/content/application~1json/examples/Search by file extension":{"value":{"from":0,"pageSize":100,"criterion":{"type":"FIELD_MATCHES","value":"*.png","field":{"type":"FIXED","fieldName":"FILENAME"}},"sorts":[]},"key":"Search by file extension","summary":"Search by file extension","id":"paths/~1asset-searches/post/requestBody/content/application~1json/examples/Search by file extension"},"paths/~1asset-searches/post/requestBody/content/application~1json/examples/Search by not file extension":{"value":{"from":0,"pageSize":100,"criterion":{"type":"NOT","criterion":[{"type":"FIELD_MATCHES","value":"*.png","field":{"type":"FIXED","fieldName":"FILENAME"}}]},"sorts":[]},"key":"Search by not file extension","summary":"Search by not file extension","id":"paths/~1asset-searches/post/requestBody/content/application~1json/examples/Search by not file extension"},"paths/~1asset-searches/post/requestBody/content/application~1json/examples/Search by multiple file extensions":{"value":{"from":0,"pageSize":100,"criterion":{"type":"OR","criteria":[{"type":"FIELD_MATCHES","value":"*.png","field":{"type":"FIXED","fieldName":"FILENAME"}},{"type":"FIELD_MATCHES","value":"*.jpg","field":{"type":"FIXED","fieldName":"FILENAME"}},{"type":"FIELD_MATCHES","value":"*.tif","field":{"type":"FIXED","fieldName":"FILENAME"}}]},"sorts":[]},"key":"Search by multiple file extensions","summary":"Search by multiple file extensions","id":"paths/~1asset-searches/post/requestBody/content/application~1json/examples/Search by multiple file extensions"},"paths/~1asset-searches/post/requestBody/content/application~1json/examples/Search by filename":{"value":{"from":0,"pageSize":100,"criterion":{"type":"FIELD_EQUALS","value":"my-image.png","field":{"type":"FIXED","fieldName":"FILENAME"}},"sorts":[]},"key":"Search by filename","summary":"Search by filename","id":"paths/~1asset-searches/post/requestBody/content/application~1json/examples/Search by filename"},"paths/~1asset-searches/post/requestBody/content/application~1json/examples/Search for staged assets staged by user":{"value":{"from":0,"pageSize":100,"criterion":{"type":"AND","criteria":[{"type":"FIELD_EQUALS","value":"STAGED","field":{"type":"FIXED","fieldName":"LIFECYCLE_STATE"}},{"type":"FIELD_EQUALS","value":"google-oauth2|110457667287511486432","field":{"type":"FIXED","fieldName":"STAGED_BY"}}]},"sorts":[]},"key":"Search for staged assets staged by user","summary":"Search for staged assets staged by user","id":"paths/~1asset-searches/post/requestBody/content/application~1json/examples/Search for staged assets staged by user"},"paths/~1asset-searches/post/requestBody/content/application~1json/examples/All assets ordered by date added":{"value":{"from":0,"pageSize":100,"criterion":{"type":"MATCH_ALL"},"sorts":[{"field":{"type":"FIXED","fieldName":"DATE_LIVE"},"order":"DESC"}]},"key":"All assets ordered by date added","summary":"All assets ordered by date added","id":"paths/~1asset-searches/post/requestBody/content/application~1json/examples/All assets ordered by date added"},"paths/~1asset-searches/post/requestBody/content/application~1json/examples/All assets in a collection":{"value":{"from":0,"pageSize":100,"criterion":{"type":"FIELD_EQUALS","value":"a32fe863-0a1d-4b54-990a-b094139cf81c","field":{"type":"FIXED","fieldName":"COLLECTIONS"}},"sorts":[{"field":{"type":"FIXED","fieldName":"DATE_LIVE"},"order":"DESC"}]},"key":"All assets in a collection","summary":"All assets in a collection","id":"paths/~1asset-searches/post/requestBody/content/application~1json/examples/All assets in a collection"},"paths/~1asset-searches/post/requestBody/content/application~1json/examples/Search within assets in a collection":{"value":{"from":0,"pageSize":100,"criterion":{"type":"AND","criteria":[{"type":"FIELD_EQUALS","value":"a32fe863-0a1d-4b54-990a-b094139cf81c","field":{"type":"FIXED","fieldName":"COLLECTIONS"}},{"type":"FIELD_MATCHES","value":"interesting things","field":{"type":"FIXED","fieldName":"KEYWORDS"}}]},"sorts":[]},"key":"Search within assets in a collection","summary":"Search within assets in a collection","id":"paths/~1asset-searches/post/requestBody/content/application~1json/examples/Search within assets in a collection"},"paths/~1asset-searches/post/requestBody/content/application~1json/examples/Match all and aggregate on filetype":{"value":{"from":0,"pageSize":100,"criterion":{"type":"MATCH_ALL"},"sorts":[],"aggregations":{"by_filetype":{"type":"TERMS","field":{"type":"FIXED","fieldName":"FILE_TYPE"}}}},"key":"Match all and aggregate on filetype","summary":"Match all and aggregate on filetype","id":"paths/~1asset-searches/post/requestBody/content/application~1json/examples/Match all and aggregate on filetype"},"paths/~1asset-scroll-searches/post/requestBody/content/application~1json/examples/All assets ordered by date added":{"value":{"pageSize":100,"criterion":{"type":"MATCH_ALL"},"sorts":[{"field":{"type":"FIXED","fieldName":"DATE_LIVE"},"order":"DESC"}]},"key":"All assets ordered by date added","summary":"All assets ordered by date added","id":"paths/~1asset-scroll-searches/post/requestBody/content/application~1json/examples/All assets ordered by date added"},"paths/~1asset-metadata-edit-batch-jobs/post/requestBody/content/application~1json/examples/Metadata only":{"value":{"selector":{"type":"BY_IDS","ids":["9e5d1db4-719d-4d61-97c8-f7fd7eec9b8a"]},"metadataFieldValueUpdates":[{"type":"BY_IDS","operation":"SET","fieldId":"3bb4e180-46df-4738-a836-6c2e1685dc2a","ids":["0f85e50b-3b24-44e0-954d-22557fdfebc7"]}]},"key":"Metadata only","summary":"Metadata only","id":"paths/~1asset-metadata-edit-batch-jobs/post/requestBody/content/application~1json/examples/Metadata only"},"paths/~1asset-metadata-edit-batch-jobs/post/requestBody/content/application~1json/examples/Variant criterion SET only":{"value":{"selector":{"type":"BY_IDS","ids":["9e5d1db4-719d-4d61-97c8-f7fd7eec9b8a"]},"metadataFieldValueUpdates":[],"variantCriterionUpdate":{"operation":"SET","criteria":[{"productId":"be2752e3-bcd6-4669-a8d9-4fd20a641e53","optionIdsByVariantFieldId":[{"3bb4e180-46df-4738-a836-6c2e1685dc2a":["0f85e50b-3b24-44e0-954d-22557fdfebc7"]}]},{"productId":"7d9c1f42-6b0e-4a1c-9f2d-2c5a1e8b3f77","optionIdsByVariantFieldId":[]}]}},"key":"Variant criterion SET only","summary":"Variant criterion SET only","id":"paths/~1asset-metadata-edit-batch-jobs/post/requestBody/content/application~1json/examples/Variant criterion SET only"},"paths/~1asset-metadata-edit-batch-jobs/post/requestBody/content/application~1json/examples/Metadata and variant criterion SET":{"value":{"selector":{"type":"BY_IDS","ids":["9e5d1db4-719d-4d61-97c8-f7fd7eec9b8a"]},"metadataFieldValueUpdates":[{"type":"BY_VALUES","operation":"SET","fieldId":"dccf77ad-b4e0-4915-8f28-70a637551aba","values":["Campaign hero"]}],"variantCriterionUpdate":{"operation":"SET","criteria":[{"productId":"be2752e3-bcd6-4669-a8d9-4fd20a641e53","optionIdsByVariantFieldId":[{"3bb4e180-46df-4738-a836-6c2e1685dc2a":["0f85e50b-3b24-44e0-954d-22557fdfebc7"]}]}]}},"key":"Metadata and variant criterion SET","summary":"Metadata and variant criterion SET","id":"paths/~1asset-metadata-edit-batch-jobs/post/requestBody/content/application~1json/examples/Metadata and variant criterion SET"},"paths/~1asset-metadata-edit-batch-jobs/post/requestBody/content/application~1json/examples/Variant criterion REMOVE":{"value":{"selector":{"type":"BY_IDS","ids":["9e5d1db4-719d-4d61-97c8-f7fd7eec9b8a"]},"metadataFieldValueUpdates":[],"variantCriterionUpdate":{"operation":"REMOVE"}},"key":"Variant criterion REMOVE","summary":"Variant criterion REMOVE","id":"paths/~1asset-metadata-edit-batch-jobs/post/requestBody/content/application~1json/examples/Variant criterion REMOVE"},"paths/~1asset-metadata-edit-batch-jobs/post/responses/200/content/application~1json/examples/In progress":{"value":{"id":"be161977-d44e-4888-af3c-66522e223963","accountId":"cfb665ca-ce35-4418-b9d5-70ee815db4bd","creatorId":"google-oauth2|110955770826801837334","type":"IN_PROGRESS","status":"PENDING","progress":{"steps":[{"id":"GET_ITEMS","status":"STARTED","completedItems":0,"totalItems":0},{"id":"PROCESS_ITEMS","status":"PENDING","completedItems":0,"totalItems":0}]}},"key":"In progress","summary":"In progress","id":"paths/~1asset-metadata-edit-batch-jobs/post/responses/200/content/application~1json/examples/In progress"},"paths/~1asset-metadata-edit-batch-jobs/post/responses/200/content/application~1json/examples/Complete":{"value":{"id":"be161977-d44e-4888-af3c-66522e223963","accountId":"cfb665ca-ce35-4418-b9d5-70ee815db4bd","creatorId":"google-oauth2|110955770826801837334","type":"COMPLETED","progress":{"steps":[{"id":"GET_ITEMS","status":"COMPLETED","completedItems":3,"totalItems":3},{"id":"PROCESS_ITEMS","status":"COMPLETED","completedItems":3,"totalItems":3}]},"dateCompleted":"2021-02-15T09:24:01.417Z"},"key":"Complete","summary":"Complete","id":"paths/~1asset-metadata-edit-batch-jobs/post/responses/200/content/application~1json/examples/Complete"},"paths/~1asset-metadata-edit-batch-jobs~1{id}/get/responses/200/content/application~1json/examples/In progress":{"value":{"id":"be161977-d44e-4888-af3c-66522e223963","accountId":"cfb665ca-ce35-4418-b9d5-70ee815db4bd","creatorId":"google-oauth2|110955770826801837334","type":"IN_PROGRESS","status":"PENDING","progress":{"steps":[{"id":"GET_ITEMS","status":"STARTED","completedItems":0,"totalItems":0},{"id":"PROCESS_ITEMS","status":"PENDING","completedItems":0,"totalItems":0}]}},"key":"In progress","summary":"In progress","id":"paths/~1asset-metadata-edit-batch-jobs~1{id}/get/responses/200/content/application~1json/examples/In progress"},"paths/~1asset-metadata-edit-batch-jobs~1{id}/get/responses/200/content/application~1json/examples/Complete":{"value":{"id":"be161977-d44e-4888-af3c-66522e223963","accountId":"cfb665ca-ce35-4418-b9d5-70ee815db4bd","creatorId":"google-oauth2|110955770826801837334","type":"COMPLETED","progress":{"steps":[{"id":"GET_ITEMS","status":"COMPLETED","completedItems":3,"totalItems":3},{"id":"PROCESS_ITEMS","status":"COMPLETED","completedItems":3,"totalItems":3}]},"dateCompleted":"2021-02-15T09:24:01.417Z"},"key":"Complete","summary":"Complete","id":"paths/~1asset-metadata-edit-batch-jobs~1{id}/get/responses/200/content/application~1json/examples/Complete"},"paths/~1asset-metadata-suggestion-batch-jobs/post/responses/200/content/application~1json/examples/In progress":{"value":{"id":"be161977-d44e-4888-af3c-66522e223963","accountId":"cfb665ca-ce35-4418-b9d5-70ee815db4bd","creatorId":"google-oauth2|110955770826801837334","type":"IN_PROGRESS","status":"PENDING","progress":{"steps":[{"id":"GET_ITEMS","status":"STARTED","completedItems":0,"totalItems":0},{"id":"PROCESS_ITEMS","status":"PENDING","completedItems":0,"totalItems":0}]}},"key":"In progress","summary":"In progress","id":"paths/~1asset-metadata-suggestion-batch-jobs/post/responses/200/content/application~1json/examples/In progress"},"paths/~1asset-metadata-suggestion-batch-jobs/post/responses/200/content/application~1json/examples/Complete":{"value":{"id":"be161977-d44e-4888-af3c-66522e223963","accountId":"cfb665ca-ce35-4418-b9d5-70ee815db4bd","creatorId":"google-oauth2|110955770826801837334","type":"COMPLETED","progress":{"steps":[{"id":"GET_ITEMS","status":"COMPLETED","completedItems":3,"totalItems":3},{"id":"PROCESS_ITEMS","status":"COMPLETED","completedItems":3,"totalItems":3}]},"dateCompleted":"2021-02-15T09:24:01.417Z"},"key":"Complete","summary":"Complete","id":"paths/~1asset-metadata-suggestion-batch-jobs/post/responses/200/content/application~1json/examples/Complete"},"paths/~1asset-metadata-suggestion-batch-jobs~1{id}/get/responses/200/content/application~1json/examples/In progress":{"value":{"id":"be161977-d44e-4888-af3c-66522e223963","accountId":"cfb665ca-ce35-4418-b9d5-70ee815db4bd","creatorId":"google-oauth2|110955770826801837334","type":"IN_PROGRESS","status":"PENDING","progress":{"steps":[{"id":"GET_ITEMS","status":"STARTED","completedItems":0,"totalItems":0},{"id":"PROCESS_ITEMS","status":"PENDING","completedItems":0,"totalItems":0}]}},"key":"In progress","summary":"In progress","id":"paths/~1asset-metadata-suggestion-batch-jobs~1{id}/get/responses/200/content/application~1json/examples/In progress"},"paths/~1asset-metadata-suggestion-batch-jobs~1{id}/get/responses/200/content/application~1json/examples/Complete":{"value":{"id":"be161977-d44e-4888-af3c-66522e223963","accountId":"cfb665ca-ce35-4418-b9d5-70ee815db4bd","creatorId":"google-oauth2|110955770826801837334","type":"COMPLETED","progress":{"steps":[{"id":"GET_ITEMS","status":"COMPLETED","completedItems":3,"totalItems":3},{"id":"PROCESS_ITEMS","status":"COMPLETED","completedItems":3,"totalItems":3}]},"dateCompleted":"2021-02-15T09:24:01.417Z"},"key":"Complete","summary":"Complete","id":"paths/~1asset-metadata-suggestion-batch-jobs~1{id}/get/responses/200/content/application~1json/examples/Complete"},"paths/~1asset-lifecycle-transition-batch-jobs/post/requestBody/content/application~1json/examples/Move all staged by user to pending approval":{"value":{"transition":"STAGED_TO_PENDING_APPROVAL","selector":{"type":"BY_CRITERION","criterion":{"type":"AND","criteria":[{"type":"FIELD_EQUALS","value":"STAGED","field":{"type":"FIXED","fieldName":"LIFECYCLE_STATE"}},{"type":"FIELD_EQUALS","value":"google-oauth2|110457667287511486432","field":{"type":"FIXED","fieldName":"STAGED_BY"}}]}}},"key":"Move all staged by user to pending approval","summary":"Move all staged by user to pending approval","id":"paths/~1asset-lifecycle-transition-batch-jobs/post/requestBody/content/application~1json/examples/Move all staged by user to pending approval"},"paths/~1asset-lifecycle-transition-batch-jobs/post/requestBody/content/application~1json/examples/Move all in pending approval to live":{"value":{"transition":"PENDING_APPROVAL_TO_LIVE","selector":{"type":"BY_CRITERION","criterion":{"type":"FIELD_EQUALS","value":"PENDING_APPROVAL","field":{"type":"FIXED","fieldName":"LIFECYCLE_STATE"}}}},"key":"Move all in pending approval to live","summary":"Move all in pending approval to live","id":"paths/~1asset-lifecycle-transition-batch-jobs/post/requestBody/content/application~1json/examples/Move all in pending approval to live"},"paths/~1asset-lifecycle-transition-batch-jobs/post/requestBody/content/application~1json/examples/Move specific asset to pending approval":{"value":{"transition":"STAGED_TO_PENDING_APPROVAL","selector":{"type":"BY_CRITERION","criterion":{"type":"AND","criteria":[{"type":"FIELD_EQUALS","value":"STAGED","field":{"type":"FIXED","fieldName":"LIFECYCLE_STATE"}},{"type":"FIELD_EQUALS","value":"4920d633-d42e-4f01-b9d2-2f65dd6363e8","field":{"type":"FIXED","fieldName":"ID"}}]}}},"key":"Move specific asset to pending approval","summary":"Move specific asset to pending approval","id":"paths/~1asset-lifecycle-transition-batch-jobs/post/requestBody/content/application~1json/examples/Move specific asset to pending approval"},"paths/~1asset-lifecycle-transition-batch-jobs/post/requestBody/content/application~1json/examples/Move specific assets to pending approval":{"value":{"transition":"STAGED_TO_PENDING_APPROVAL","selector":{"type":"BY_CRITERION","criterion":{"type":"AND","criteria":[{"type":"FIELD_EQUALS","value":"STAGED","field":{"type":"FIXED","fieldName":"LIFECYCLE_STATE"}},{"type":"OR","criteria":[{"type":"FIELD_EQUALS","value":"4920d633-d42e-4f01-b9d2-2f65dd6363e8","field":{"type":"FIXED","fieldName":"ID"}},{"type":"FIELD_EQUALS","value":"0454170b-b80e-42bf-b7a9-99c5f6a78fbb","field":{"type":"FIXED","fieldName":"ID"}},{"type":"FIELD_EQUALS","value":"8d1f8bf8-d712-46ee-9642-5a725bc486f2","field":{"type":"FIXED","fieldName":"ID"}}]}]}}},"key":"Move specific assets to pending approval","summary":"Move specific assets to pending approval","id":"paths/~1asset-lifecycle-transition-batch-jobs/post/requestBody/content/application~1json/examples/Move specific assets to pending approval"},"paths/~1asset-lifecycle-transition-batch-jobs/post/responses/200/content/application~1json/examples/In progress":{"value":{"id":"be161977-d44e-4888-af3c-66522e223963","accountId":"cfb665ca-ce35-4418-b9d5-70ee815db4bd","creatorId":"google-oauth2|110955770826801837334","type":"IN_PROGRESS","status":"PENDING","progress":{"steps":[{"id":"lifecycleTransitionGetJobItemsStep","status":"STARTED","completedItems":0,"totalItems":0},{"id":"lifecycleTransitionProcessJobItemsStep","status":"PENDING","completedItems":0,"totalItems":0}]}},"key":"In progress","summary":"In progress","id":"paths/~1asset-lifecycle-transition-batch-jobs/post/responses/200/content/application~1json/examples/In progress"},"paths/~1asset-lifecycle-transition-batch-jobs~1{id}/get/responses/200/content/application~1json/examples/Complete":{"value":{"id":"be161977-d44e-4888-af3c-66522e223963","accountId":"cfb665ca-ce35-4418-b9d5-70ee815db4bd","creatorId":"google-oauth2|110955770826801837334","type":"COMPLETED","progress":{"steps":[{"id":"lifecycleTransitionGetJobItemsStep","status":"COMPLETED","completedItems":3,"totalItems":3},{"id":"lifecycleTransitionProcessJobItemsStep","status":"COMPLETED","completedItems":3,"totalItems":3}]},"dateCompleted":"2021-02-15T09:24:01.417Z"},"key":"Complete","summary":"Complete","id":"paths/~1asset-lifecycle-transition-batch-jobs~1{id}/get/responses/200/content/application~1json/examples/Complete"},"paths/~1asset-deduplication-batch-jobs~1{id}/get/responses/200/content/application~1json/examples/Completed":{"value":{"id":"be161977-d44e-4888-af3c-66522e223963","accountId":"cfb665ca-ce35-4418-b9d5-70ee815db4bd","creatorId":"google-oauth2|110955770826801837334","type":"COMPLETED","progress":{"steps":[{"name":"deduplicationGetJobItemsStep","status":"COMPLETED","completedItems":2,"totalItems":2},{"name":"deduplicationProcessJobItemsStep","status":"COMPLETED","completedItems":2,"totalItems":2}]},"dateCompleted":"2021-02-15T09:24:01.417Z","result":{"deduplicatedAssetCount":42}},"key":"Completed","summary":"Completed","id":"paths/~1asset-deduplication-batch-jobs~1{id}/get/responses/200/content/application~1json/examples/Completed"},"paths/~1embeddable-link-batch-jobs/post/responses/200/content/application~1json/examples/In progress":{"value":{"id":"be161977-d44e-4888-af3c-66522e223963","accountId":"cfb665ca-ce35-4418-b9d5-70ee815db4bd","creatorId":"google-oauth2|110955770826801837334","type":"IN_PROGRESS","status":"PENDING","progress":{"steps":[{"id":"embeddableLinkGetJobItemsStep","status":"STARTED","completedItems":0,"totalItems":0},{"id":"embeddableLinkProcessJobItemsStep","status":"PENDING","completedItems":0,"totalItems":0}]}},"key":"In progress","summary":"In progress","id":"paths/~1embeddable-link-batch-jobs/post/responses/200/content/application~1json/examples/In progress"},"paths/~1asset-metadata-export-batch-jobs~1{id}/get/responses/200/content/application~1json/examples/Completed":{"value":{"id":"be161977-d44e-4888-af3c-66522e223963","accountId":"cfb665ca-ce35-4418-b9d5-70ee815db4bd","creatorId":"google-oauth2|110955770826801837334","type":"COMPLETED","progress":{"steps":[{"id":"METADATA_EXPORT_GET_JOB_ITEMS","status":"COMPLETED","completedItems":2,"totalItems":2},{"id":"METADATA_EXPORT_PROCESS_ITEMS","status":"COMPLETED","completedItems":2,"totalItems":2}]},"dateCompleted":"2021-02-15T09:24:01.417Z","result":{"downloadUrl":"https://csv-url-example.here"}},"key":"Completed","summary":"Completed","id":"paths/~1asset-metadata-export-batch-jobs~1{id}/get/responses/200/content/application~1json/examples/Completed"},"paths/~1asset-metadata-export-batch-jobs~1{id}/patch/responses/200/content/application~1json/examples/Completed":{"value":{"id":"be161977-d44e-4888-af3c-66522e223963","accountId":"cfb665ca-ce35-4418-b9d5-70ee815db4bd","creatorId":"google-oauth2|110955770826801837334","type":"COMPLETED","progress":{"steps":[{"id":"METADATA_EXPORT_GET_JOB_ITEMS","status":"COMPLETED","completedItems":2,"totalItems":2},{"id":"METADATA_EXPORT_PROCESS_ITEMS","status":"COMPLETED","completedItems":2,"totalItems":2}]},"dateCompleted":"2021-02-15T09:24:01.417Z","result":{"downloadUrl":"https://csv-url-example.here"}},"key":"Completed","summary":"Completed","id":"paths/~1asset-metadata-export-batch-jobs~1{id}/patch/responses/200/content/application~1json/examples/Completed"},"paths/~1asset-variant-criteria~1{id}/get/responses/200/content/application~1json/examples/For selected product variant values":{"value":{"result":{"id":"e5e4b297-29e7-4a78-8f9f-97f7a02df8df","accountId":"2d8f0349-4e9c-4df5-bd4d-8c96e4f91851","assetId":"2807728f-2c48-422b-a7a8-f9adee425f32","productId":"54f26d2c-ae22-4185-81b4-ae8b947d4d8f","optionIdsByVariantFieldId":[{"3bb4e180-46df-4738-a836-6c2e1685dc2a":["0f85e50b-3b24-44e0-954d-22557fdfebc7","8f70afc5-6424-44f5-80e9-092204b7a30e"]}]},"permittedActions":[]},"key":"For selected product variant values","summary":"For selected product variant values","id":"paths/~1asset-variant-criteria~1{id}/get/responses/200/content/application~1json/examples/For selected product variant values"},"paths/~1collection-searches/post/requestBody/content/application~1json/examples/Search for collections associated with user":{"value":{"from":0,"pageSize":100,"criterion":{"type":"ASSOCIATED_WITH_USER","userId":"google-oauth2|110955770826801837334"},"sorts":[{"field":"NAME","order":"ASC"}]},"key":"Search for collections associated with user","summary":"Search for collections associated with user","id":"paths/~1collection-searches/post/requestBody/content/application~1json/examples/Search for collections associated with user"},"paths/~1collection-searches/post/responses/200/content/application~1json/examples/Search for collections associated with user":{"value":{"results":[{"result":{"id":"1ecabbb8-85d5-11eb-8dcd-0242ac130003","accountId":"cfb665ca-ce35-4418-b9d5-70ee815db4bd","name":"Collaboration Collection","createdBy":"google-oauth2|340955570626871847637","dateCreated":"2021-04-15T09:24:01.417Z","permittedActions":[]}},{"result":{"id":"1fc6d6c3-c42d-48e2-b0db-5d680a58ca52","accountId":"cfb665ca-ce35-4418-b9d5-70ee815db4bd","name":"My Collection 1","createdBy":"google-oauth2|110955770826801837334","dateCreated":"2021-02-15T09:24:01.417Z"},"permittedActions":[]},{"result":{"id":"a52b5315-15b8-417f-b742-d6902108bac1","accountId":"cfb665ca-ce35-4418-b9d5-70ee815db4bd","name":"My Collection 2","createdBy":"google-oauth2|110955770826801837334","dateCreated":"2021-03-15T09:24:01.417Z"},"permittedActions":[]}],"totalResults":3},"key":"Search for collections associated with user","summary":"Search for collections associated with user","id":"paths/~1collection-searches/post/responses/200/content/application~1json/examples/Search for collections associated with user"},"paths/~1asset-download-event-searches/post/requestBody/content/application~1json/examples/Search downloads by user id":{"value":{"from":0,"pageSize":100,"criterion":{"type":"FIELD_EQUALS","field":"USER_ID","value":"162c8739-b830-4d2f-b241-97951734a04e"},"sorts":[{"field":"DATE_TIME","order":"DESC"}],"aggregations":{}},"key":"Search downloads by user id","summary":"Search downloads by user id","id":"paths/~1asset-download-event-searches/post/requestBody/content/application~1json/examples/Search downloads by user id"},"paths/~1asset-download-event-searches/post/requestBody/content/application~1json/examples/Search downloads by user email and asset id":{"value":{"from":0,"pageSize":100,"criterion":{"type":"AND","criteria":[{"type":"FIELD_EQUALS","field":"ASSET_ID","value":"c1045fb1-da2c-4190-8aec-741bdc31ad88"},{"type":"FIELD_EQUALS","field":"USER_EMAIL","value":"joe-bloggs@test.com"}]},"sorts":[{"field":"DATE_TIME","order":"ASC"}],"aggregations":{}},"key":"Search downloads by user email and asset id","summary":"Search downloads by user email and asset id","id":"paths/~1asset-download-event-searches/post/requestBody/content/application~1json/examples/Search downloads by user email and asset id"},"paths/~1asset-download-event-searches/post/requestBody/content/application~1json/examples/Search downloads by multiple asset ids":{"value":{"from":0,"pageSize":100,"criterion":{"type":"OR","criteria":[{"type":"FIELD_EQUALS","field":"ASSET_ID","value":"c1045fb1-da2c-4190-8aec-741bdc31ad88"},{"type":"FIELD_EQUALS","field":"ASSET_ID","value":"28f1a532-5a86-4c0d-80a9-b3b67a9edcdd"},{"type":"FIELD_EQUALS","field":"ASSET_ID","value":"7b00d039-9b01-436c-8632-15a33f024ee2"}]},"sorts":[{"field":"ASSET_ID","order":"ASC"},{"field":"DATE_TIME","order":"ASC"}],"aggregations":{}},"key":"Search downloads by multiple asset ids","summary":"Search downloads by multiple asset ids","id":"paths/~1asset-download-event-searches/post/requestBody/content/application~1json/examples/Search downloads by multiple asset ids"},"paths/~1asset-download-event-searches/post/requestBody/content/application~1json/examples/Search downloads within date range":{"value":{"from":0,"pageSize":100,"criterion":{"type":"FIELD_IN_RANGE","field":"DATE_TIME","from":"2023-09-24T12:57:34.295Z","to":"2023-10-24T12:57:34.295"},"sorts":[{"field":"DATE_TIME","order":"DESC"}],"aggregations":{}},"key":"Search downloads within date range","summary":"Search downloads within date range","id":"paths/~1asset-download-event-searches/post/requestBody/content/application~1json/examples/Search downloads within date range"},"paths/~1asset-download-event-searches/post/requestBody/content/application~1json/examples/Aggregate all downloads by date":{"value":{"from":0,"pageSize":0,"criterion":{"type":"MATCH_ALL"},"sorts":[],"aggregations":{"by_day":{"type":"DATE_HISTOGRAM","field":"DATE_TIME","interval":"ONE_DAY","lowerBound":"2023-10-17T00:00:00.295Z","upperBound":"2023-10-24T23:59:59.295Z"}}},"key":"Aggregate all downloads by date","summary":"Aggregate all downloads by date","id":"paths/~1asset-download-event-searches/post/requestBody/content/application~1json/examples/Aggregate all downloads by date"},"paths/~1asset-download-event-searches/post/requestBody/content/application~1json/examples/Aggregate portal downloads by portal":{"value":{"from":0,"pageSize":0,"criterion":{"type":"FIELD_EQUALS","field":"USER_TYPE","value":"PORTAL_USER"},"sorts":[],"aggregations":{"by_portal":{"type":"TERMS","field":"PORTAL_ID"}}},"key":"Aggregate portal downloads by portal","summary":"Aggregate portal downloads by portal","id":"paths/~1asset-download-event-searches/post/requestBody/content/application~1json/examples/Aggregate portal downloads by portal"},"paths/~1asset-download-event-searches/post/requestBody/content/application~1json/examples/Aggregate account user downloads by user id":{"value":{"from":0,"pageSize":0,"criterion":{"type":"FIELD_EQUALS","field":"USER_TYPE","value":"ACCOUNT_USER"},"sorts":[],"aggregations":{"by_user":{"type":"TERMS","field":"USER_ID"}}},"key":"Aggregate account user downloads by user id","summary":"Aggregate account user downloads by user id","id":"paths/~1asset-download-event-searches/post/requestBody/content/application~1json/examples/Aggregate account user downloads by user id"},"paths/~1asset-download-event-searches/post/requestBody/content/application~1json/examples/Aggregate account user downloads by user id and asset id":{"value":{"from":0,"pageSize":0,"criterion":{"type":"FIELD_EQUALS","field":"USER_TYPE","value":"ACCOUNT_USER"},"sorts":[],"aggregations":{"by_user":{"type":"TERMS","field":"USER_ID"},"by_asset":{"type":"TERMS","field":"ASSET_ID"}}},"key":"Aggregate account user downloads by user id and asset id","summary":"Aggregate account user downloads by user id and asset id","id":"paths/~1asset-download-event-searches/post/requestBody/content/application~1json/examples/Aggregate account user downloads by user id and asset id"},"paths/~1asset-download-event-searches/post/responses/200/content/application~1json/examples/Results with paged events without aggregations":{"value":{"totalResults":3,"results":[{"result":{"id":"7d240457-6232-4702-af61-7ce5e6ffc34e","accountId":"a61a254c-4bbd-41e6-ba52-22a82ce9fca1","assetId":"2441039a-fb70-4cf8-8070-b2ac6a70186f","assetFileId":"2441239a-fb70-4cf8-8070-b2ac6a60186f","dateTime":"2023-10-23T17:05:28.68Z","downloadType":"PRESET","downloadDescription":"Large","downloadPresetId":"a2b1817f-ba85-47cf-87ec-3183df7a9bd0","userData":{"type":"ACCOUNT_USER","userId":"google-oauth2|101322069082130951052","userEmail":"joe-blogs@test.com"}},"permittedActions":[]},{"result":{"id":"9d240457-6232-4702-af61-7ce5e6ffc34e","accountId":"a61a254c-4bbd-41e6-ba52-22a82ce9fca1","assetId":"2441039a-fb70-4cf8-8070-b2ac6a70186f","assetFileId":"3441239a-fb70-4cf8-8070-b2ac6a60186f","dateTime":"2023-11-23T17:05:28.68Z","downloadType":"PRESET","downloadDescription":"Small","downloadPresetId":"a2b1817f-ba85-47cf-87ec-3183df7a9bd0","userData":{"type":"ACCOUNT_USER","userId":"google-oauth2|201322069082130951052","userEmail":"sue-blogs@test.com"}},"permittedActions":[]},{"result":{"id":"9d240457-6232-4702-af61-7ce5e6ffc34e","accountId":"a61a254c-4bbd-41e6-ba52-22a82ce9fca1","assetId":"3441039a-fb70-4cf8-8070-b2ac6a70186f","assetFileId":"3441239a-fb70-4cf8-8070-b2ac6a60186f","dateTime":"2023-11-23T17:05:28.68Z","downloadType":"PRESET","downloadDescription":"Small","downloadPresetId":"a2b1817f-ba85-47cf-87ec-3183df7a9bd0","userData":{"type":"ACCOUNT_USER","userId":"google-oauth2|201322069082130951052","userEmail":"sue-blogs@test.com"}},"permittedActions":[]}],"aggregations":[]},"key":"Results with paged events without aggregations","summary":"Results with paged events without aggregations","id":"paths/~1asset-download-event-searches/post/responses/200/content/application~1json/examples/Results with paged events without aggregations"},"paths/~1asset-download-event-searches/post/responses/200/content/application~1json/examples/Results with paged events with aggregations":{"value":{"totalResults":3,"results":[{"result":{"id":"7d240457-6232-4702-af61-7ce5e6ffc34e","accountId":"a61a254c-4bbd-41e6-ba52-22a82ce9fca1","assetId":"2441039a-fb70-4cf8-8070-b2ac6a70186f","assetFileId":"2441239a-fb70-4cf8-8070-b2ac6a60186f","dateTime":"2023-10-23T17:05:28.68Z","downloadType":"PRESET","downloadDescription":"Large","downloadPresetId":"a2b1817f-ba85-47cf-87ec-3183df7a9bd0","userData":{"type":"ACCOUNT_USER","userId":"google-oauth2|101322069082130951052","userEmail":"joe-blogs@test.com"}},"permittedActions":[]},{"result":{"id":"9d240457-6232-4702-af61-7ce5e6ffc34e","accountId":"a61a254c-4bbd-41e6-ba52-22a82ce9fca1","assetId":"2441039a-fb70-4cf8-8070-b2ac6a70186f","assetFileId":"3441239a-fb70-4cf8-8070-b2ac6a60186f","dateTime":"2023-11-23T17:05:28.68Z","downloadType":"PRESET","downloadDescription":"Small","downloadPresetId":"a2b1817f-ba85-47cf-87ec-3183df7a9bd0","userData":{"type":"ACCOUNT_USER","userId":"google-oauth2|201322069082130951052","userEmail":"sue-blogs@test.com"}},"permittedActions":[]},{"result":{"id":"9d240457-6232-4702-af61-7ce5e6ffc34e","accountId":"a61a254c-4bbd-41e6-ba52-22a82ce9fca1","assetId":"3441039a-fb70-4cf8-8070-b2ac6a70186f","assetFileId":"3441239a-fb70-4cf8-8070-b2ac6a60186f","dateTime":"2023-11-23T17:05:28.68Z","downloadType":"PRESET","downloadDescription":"Small","downloadPresetId":"a2b1817f-ba85-47cf-87ec-3183df7a9bd0","userData":{"type":"ACCOUNT_USER","userId":"google-oauth2|201322069082130951052","userEmail":"sue-blogs@test.com"}},"permittedActions":[]}],"aggregations":{"by_user_email":{"type":"BUCKET","buckets":[{"key":"joe-blogs@test.com","count":1},{"key":"sue-blogs@test.com","count":2}]}}},"key":"Results with paged events with aggregations","summary":"Results with paged events with aggregations","id":"paths/~1asset-download-event-searches/post/responses/200/content/application~1json/examples/Results with paged events with aggregations"},"paths/~1asset-download-event-searches/post/responses/200/content/application~1json/examples/Results without paged events with terms bucket aggregations":{"value":{"totalResults":10,"results":[],"aggregations":{"by_portal_id":{"type":"BUCKET","buckets":[{"key":"dc530896-8664-41b5-abc2-612976792b06","count":1},{"key":"6f530896-8664-41b5-abc2-612976792b06","count":5},{"key":"ea6ed9bd-871b-4df4-8762-09d55bafac87","count":4}]}}},"key":"Results without paged events with terms bucket aggregations","summary":"Results without paged events with terms bucket aggregations","id":"paths/~1asset-download-event-searches/post/responses/200/content/application~1json/examples/Results without paged events with terms bucket aggregations"},"paths/~1asset-download-event-searches/post/responses/200/content/application~1json/examples/Results without paged events with multiple terms bucket aggregations":{"value":{"totalResults":3,"results":[],"aggregations":{"by_user_email":{"type":"BUCKET","buckets":[{"key":"joe-blogs@test.com","count":1},{"key":"sue-blogs@test.com","count":2}]},"by_asset_id":{"type":"BUCKET","buckets":[{"key":"dc530896-8664-41b5-abc2-612976792b06","count":1},{"key":"6f530896-8664-41b5-abc2-612976792b06","count":1},{"key":"ea6ed9bd-871b-4df4-8762-09d55bafac87","count":1}]}}},"key":"Results without paged events with multiple terms bucket aggregations","summary":"Results without paged events with multiple terms bucket aggregations","id":"paths/~1asset-download-event-searches/post/responses/200/content/application~1json/examples/Results without paged events with multiple terms bucket aggregations"},"paths/~1asset-download-event-searches/post/responses/200/content/application~1json/examples/Results without paged events with date histogram bucket aggregations":{"value":{"totalResults":20,"results":[],"aggregations":{"by_day":{"type":"BUCKET","buckets":[{"key":"2023-09-17T00:00:00.000Z","count":0},{"key":"2023-09-17T00:00:00.000Z","count":5},{"key":"2023-09-17T00:00:00.000Z","count":4},{"key":"2023-09-17T00:00:00.000Z","count":10},{"key":"2023-09-17T00:00:00.000Z","count":0},{"key":"2023-09-17T00:00:00.000Z","count":1},{"key":"2023-09-17T00:00:00.000Z","count":0}]}}},"key":"Results without paged events with date histogram bucket aggregations","summary":"Results without paged events with date histogram bucket aggregations","id":"paths/~1asset-download-event-searches/post/responses/200/content/application~1json/examples/Results without paged events with date histogram bucket aggregations"},"paths/~1asset-download-event-searches/post/responses/200/content/application~1json/examples/No results":{"value":{"totalResults":0,"results":[],"aggregations":[]},"key":"No results","summary":"No results","id":"paths/~1asset-download-event-searches/post/responses/200/content/application~1json/examples/No results"},"paths/~1field-options/post/requestBody/content/application~1json/examples/Create at top level":{"value":{"fieldId":"a52b5315-15b8-417f-b742-d6902108bac1","value":"My Top Level Folder","position":3,"parentId":null},"key":"Create at top level","summary":"Create at top level","id":"paths/~1field-options/post/requestBody/content/application~1json/examples/Create at top level"},"paths/~1field-options/post/requestBody/content/application~1json/examples/Create at sub level":{"value":{"fieldId":"a52b5315-15b8-417f-b742-d6902108bac1","value":"My Sub Folder","position":0,"parentId":"1fc6d6c3-c42d-48e2-b0db-5d680a58ca52"},"key":"Create at sub level","summary":"Create at sub level","id":"paths/~1field-options/post/requestBody/content/application~1json/examples/Create at sub level"},"paths/~1field-options/post/responses/200/content/application~1json/examples/Create at top level":{"value":{"result":{"id":"1fc6d6c3-c42d-48e2-b0db-5d680a58ca52","fieldId":"a52b5315-15b8-417f-b742-d6902108bac1","value":"My Top Level Folder","position":0,"leaf":false,"parent":null},"permittedActions":[]},"key":"Create at top level","summary":"Create at top level","id":"paths/~1field-options/post/responses/200/content/application~1json/examples/Create at top level"},"paths/~1field-options/post/responses/200/content/application~1json/examples/Create at sub level":{"value":{"result":{"id":"1ecabbb8-85d5-11eb-8dcd-0242ac130003","fieldId":"a52b5315-15b8-417f-b742-d6902108bac1","value":"Another Sub Folder","position":1,"leaf":true,"parent":{"result":{"id":"1fc6d6c3-c42d-48e2-b0db-5d680a58ca52","fieldId":"a52b5315-15b8-417f-b742-d6902108bac1","value":"My Top Level Folder","position":0,"leaf":false,"parent":null},"permittedActions":[]},"permittedActions":[]}},"key":"Create at sub level","summary":"Create at sub level","id":"paths/~1field-options/post/responses/200/content/application~1json/examples/Create at sub level"},"paths/~1field-options~1{id}/get/responses/200/content/application~1json/examples/Without parent":{"value":{"result":{"id":"1fc6d6c3-c42d-48e2-b0db-5d680a58ca52","fieldId":"a52b5315-15b8-417f-b742-d6902108bac1","value":"My Top Level Folder","position":0,"leaf":false,"parent":null},"permittedActions":[]},"key":"Without parent","summary":"Without parent","id":"paths/~1field-options~1{id}/get/responses/200/content/application~1json/examples/Without parent"},"paths/~1field-options~1{id}/get/responses/200/content/application~1json/examples/With parent":{"value":{"result":{"id":"1ecabbb8-85d5-11eb-8dcd-0242ac130003","fieldId":"a52b5315-15b8-417f-b742-d6902108bac1","value":"Another Sub Folder","position":1,"leaf":true,"parent":{"result":{"id":"1fc6d6c3-c42d-48e2-b0db-5d680a58ca52","fieldId":"a52b5315-15b8-417f-b742-d6902108bac1","value":"My Top Level Folder","position":0,"leaf":false,"parent":null},"permittedActions":[]},"permittedActions":[]}},"key":"With parent","summary":"With parent","id":"paths/~1field-options~1{id}/get/responses/200/content/application~1json/examples/With parent"},"paths/~1field-option-searches/post/requestBody/content/application~1json/examples/Search for top level options":{"value":{"from":0,"pageSize":100,"criterion":{"type":"AND","criteria":[{"type":"FIELD_EQUALS","field":"FIELD_ID","value":"a52b5315-15b8-417f-b742-d6902108bac1"},{"type":"FIELD_IS_EMPTY","field":"PARENT_ID"}]},"sorts":[{"field":"POSITION","order":"ASC"}]},"key":"Search for top level options","summary":"Search for top level options","id":"paths/~1field-option-searches/post/requestBody/content/application~1json/examples/Search for top level options"},"paths/~1field-option-searches/post/requestBody/content/application~1json/examples/Search for sub level options":{"value":{"from":0,"pageSize":100,"criterion":{"type":"AND","criteria":[{"type":"FIELD_EQUALS","field":"FIELD_ID","value":"a52b5315-15b8-417f-b742-d6902108bac1"},{"type":"FIELD_EQUALS","field":"PARENT_ID","value":"1fc6d6c3-c42d-48e2-b0db-5d680a58ca52"}]},"sorts":[{"field":"POSITION","order":"ASC"}]},"key":"Search for sub level options","summary":"Search for sub level options","id":"paths/~1field-option-searches/post/requestBody/content/application~1json/examples/Search for sub level options"},"paths/~1field-option-searches/post/requestBody/content/application~1json/examples/Search for all options for a field":{"value":{"from":0,"pageSize":1,"criterion":{"type":"FIELD_EQUALS","field":"FIELD_ID","value":"a52b5315-15b8-417f-b742-d6902108bac1"},"sorts":[]},"key":"Search for all options for a field","summary":"Search for all options for a field","id":"paths/~1field-option-searches/post/requestBody/content/application~1json/examples/Search for all options for a field"},"paths/~1field-option-searches/post/responses/200/content/application~1json/examples/Search for top level options":{"value":{"results":[{"result":{"id":"1fc6d6c3-c42d-48e2-b0db-5d680a58ca52","fieldId":"a52b5315-15b8-417f-b742-d6902108bac1","value":"My Top Level Folder","position":0,"leaf":false,"parent":null},"permittedActions":[]},{"result":{"id":"1fc6d6c3-c42d-48e2-b0db-5d680a58ca52","fieldId":"a52b5315-15b8-417f-b742-d6902108bac1","value":"Another Top Level Folder","position":1,"leaf":false,"parent":null},"permittedActions":[]}],"totalResults":2},"key":"Search for top level options","summary":"Search for top level options","id":"paths/~1field-option-searches/post/responses/200/content/application~1json/examples/Search for top level options"},"paths/~1field-option-searches/post/responses/200/content/application~1json/examples/Search for sub level options":{"value":{"results":[{"result":{"result":{"id":"8f6ef636-85d0-11eb-8dcd-0242ac130003","fieldId":"a52b5315-15b8-417f-b742-d6902108bac1","value":"My Sub Folder","position":0,"leaf":true,"parent":{"result":{"id":"1fc6d6c3-c42d-48e2-b0db-5d680a58ca52","fieldId":"a52b5315-15b8-417f-b742-d6902108bac1","value":"My Top Level Folder","position":0,"leaf":false,"parent":null},"permittedActions":[]},"permittedActions":[]}}},{"result":{"id":"1ecabbb8-85d5-11eb-8dcd-0242ac130003","fieldId":"a52b5315-15b8-417f-b742-d6902108bac1","value":"Another Sub Folder","position":1,"leaf":true,"parent":{"result":{"id":"1fc6d6c3-c42d-48e2-b0db-5d680a58ca52","fieldId":"a52b5315-15b8-417f-b742-d6902108bac1","value":"My Top Level Folder","position":0,"leaf":false,"parent":null},"permittedActions":[]},"permittedActions":[]}}],"totalResults":2},"key":"Search for sub level options","summary":"Search for sub level options","id":"paths/~1field-option-searches/post/responses/200/content/application~1json/examples/Search for sub level options"},"paths/~1field-option-searches/post/responses/200/content/application~1json/examples/Search for all options for a field":{"value":{"results":[{"result":{"id":"1fc6d6c3-c42d-48e2-b0db-5d680a58ca52","fieldId":"a52b5315-15b8-417f-b742-d6902108bac1","value":"A folder","position":0,"leaf":false,"parent":null},"permittedActions":[]}],"totalResults":568},"key":"Search for all options for a field","summary":"Search for all options for a field","id":"paths/~1field-option-searches/post/responses/200/content/application~1json/examples/Search for all options for a field"},"paths/~1field-option-images/post/requestBody/content/application~1json/examples/Get field option images for a few field options":{"value":{"items":[{"batchItemId":1,"fieldOptionId":"1fc6d6c3-c42d-48e2-b0db-5d680a58ca52"},{"batchItemId":2,"fieldOptionId":"1ecabbb8-85d5-11eb-8dcd-0242ac130003"},{"batchItemId":3,"fieldOptionId":"5a2481e0-819f-4b46-a7e6-143f943345f2"}]},"key":"Get field option images for a few field options","summary":"Get field option images for a few field options","id":"paths/~1field-option-images/post/requestBody/content/application~1json/examples/Get field option images for a few field options"},"paths/~1field-option-images/post/responses/200/content/application~1json/examples/Get field option images for a few field options":{"value":{"successes":{"1":{"accountId":"cfb665ca-ce35-4418-b9d5-70ee815db4bd","fieldId":"7756d388-110c-4712-b350-0b2b48e156c1","fieldOptionId":"1fc6d6c3-c42d-48e2-b0db-5d680a58ca52","url":"https://example.com"},"2":{"accountId":"cfb665ca-ce35-4418-b9d5-70ee815db4bd","fieldId":"7756d388-110c-4712-b350-0b2b48e156c1","fieldOptionId":"1ecabbb8-85d5-11eb-8dcd-0242ac130003","url":"https://example.com"}},"failures":{"3":"FIELD_OPTION_IMAGE_DOES_NOT_EXIST"}},"key":"Get field option images for a few field options","summary":"Get field option images for a few field options","id":"paths/~1field-option-images/post/responses/200/content/application~1json/examples/Get field option images for a few field options"},"paths/~1field-option-image-uploads/post/requestBody/content/application~1json/examples/Get an image upload object":{"value":{"accountId":"cfb665ca-ce35-4418-b9d5-70ee815db4bd","fieldId":"7756d388-110c-4712-b350-0b2b48e156c1","fieldOptionId":"1fc6d6c3-c42d-48e2-b0db-5d680a58ca52"},"key":"Get an image upload object","summary":"Get an image upload object","id":"paths/~1field-option-image-uploads/post/requestBody/content/application~1json/examples/Get an image upload object"},"paths/~1field-option-image-uploads/post/responses/200/content/application~1json/examples/Get an image upload object":{"value":{"url":"https://example.com"},"key":"Get an image upload object","summary":"Get an image upload object","id":"paths/~1field-option-image-uploads/post/responses/200/content/application~1json/examples/Get an image upload object"},"paths/~1saved-search-searches/post/requestBody/content/application~1json/examples/Search for saved searches created by a user":{"value":{"from":0,"pageSize":100,"criterion":{"type":"FIELD_EQUALS","field":"CREATOR_ID","value":"google-oauth2|110955770826801837334"},"sorts":[]},"key":"Search for saved searches created by a user","summary":"Search for saved searches created by a user","id":"paths/~1saved-search-searches/post/requestBody/content/application~1json/examples/Search for saved searches created by a user"},"paths/~1saved-search-searches/post/responses/200/content/application~1json/examples/Search for saved searches created by a user":{"value":{"results":[{"result":{"id":"1ecabbb8-85d5-11eb-8dcd-0242ac130003","accountId":"cfb665ca-ce35-4418-b9d5-70ee815db4bd","creatorId":"google-oauth2|340955570626871847637","name":"Favourite search","emailUserOnNewUploads":true,"criterion":{"type":"FIELD_EQUALS","value":"a32fe863-0a1d-4b54-990a-b094139cf81c","field":{"type":"FIELD","fieldId":"a52b5315-15b8-417f-b742-d6902108bac1"}},"sorts":[]},"permittedActions":[]},{"result":{"id":"1fc6d6c3-c42d-48e2-b0db-5d680a58ca52","accountId":"cfb665ca-ce35-4418-b9d5-70ee815db4bd","creatorId":"google-oauth2|340955570626871847637","name":"Added in January","emailUserOnNewUploads":false,"criterion":{"type":"FIELD_MATCHES","value":"[2021-01-01 TO 2021-02-01]","field":{"type":"FIXED","fieldName":"DATE_LIVE"}},"sorts":[]},"permittedActions":[]},{"result":{"id":"a52b5315-15b8-417f-b742-d6902108bac1","accountId":"cfb665ca-ce35-4418-b9d5-70ee815db4bd","creatorId":"google-oauth2|340955570626871847637","name":"My saved search","emailUserOnNewUploads":true,"criterion":{"type":"MATCH_ALL"},"sorts":[{"field":{"type":"FIXED","fieldName":"DATE_LIVE"},"order":"DESC"}]},"permittedActions":[]}],"totalResults":3},"key":"Search for saved searches created by a user","summary":"Search for saved searches created by a user","id":"paths/~1saved-search-searches/post/responses/200/content/application~1json/examples/Search for saved searches created by a user"}},"securitySchemeStore":{"bearerToken":{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"},"portalPasscode":{"id":"portalPasscode","type":"apiKey","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prefix the value with \"Passcode \""},"children":[]}]}]}],"in":"header","paramName":"Authorization"}},"servers":[{"url":"https://api-v2.dash.app","description":"Production"},{"url":"https://api-v2.dashstaging.app","description":"Staging"}]},"options":{"hidePropertiesPrefix":true,"hideSchemaTitles":true,"hideSidebar":true,"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/dash/@v2/openapi.json?download"},{"url":"/_bundle/dash/@v2/openapi.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Dash API","description":"# Introduction\n\nThe Dash API follows the [REST](https://en.wikipedia.org/wiki/Representational_state_transfer) standard and uses common [HTTP](https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol) headers, methods and response codes.\nRequest and response bodies are all in [JSON](https://www.json.org/json-en.html) format except for `PUT` requests of binary file data when upload files.\n\n# Operations, Jobs and Batches\n\nIf the standard `PUT`, `PATCH` and `DELETE` methods cannot adequately describe an operation on a resource the operation may itself  be treated as a resource and the endpoint URLs will reflect this accordingly.\nFor example making a `POST` to `/asset-uploads` returns an [`AssetUpload`](/dash/openapi/assets/postassetupload) resource which describes the URL(s) the client should `PUT` the binary data to upload a file to an asset.\n\nIf an operation is unlikely to complete via a synchronous REST call, or asynchronous behaviour is simply preferable, job resource endpoints may provided for the operation.\nCreated job resources can then be periodically polled to Get the status of the operation.\nSuch endpoints can be expected to contain a `job` qualifier. e.g `/asset-download-jobs` and `/asset-download-jobs/{id}`\n\nAll job resources can be expected to conform to a polymorphic job structure with common properties such as `id`, `progress` and type specific properties such as `dateCompleted` for successfully completed jobs.\n\nIf an operation can be applied to multiple resources an endpoint may provided to create a batch resource for the operation.\nSuch endpoints can be expected to contain a `batch` qualifier.\nAs batch operations almost always need to be asynchronous you can expect to see both qualifiers in the endpoint URL e.g `/asset-download-batch-jobs` and `/asset-download-batch-jobs/{id}`.\n\n\n# Authorisation\n\n## Get a short-lived bearer token for testing\n\nYou should read the [OAuth2 section](#section/Authorisation/OAuth2) if you want to set up programmatic API access to Dash. However, if you just want to try out an API endpoint, or want to [request your client ID and secret](/dash/openapi/custom/putcustomintegrationsettings) (required for OAuth2 below), you can get a short-lived bearer token:\n\n1. Log in to your Dash account as normal\n2. Open the browser developer tools (CMD + OPTION + I on Mac or CTRL + SHIFT + I on Windows)\n3. Click the \"Application\" tab\n4. Under \"Storage\" in the left panel, expand \"local storage\"\n5. Click on the URL of your Dash site\n6. Copy the \"value\" for the access_token from the right-hand panel (be sure to select the whole thing - double click to edit, select all then copy).\n\nThis token can be used to try out an endpoint directly from these docs. Just click \"Try it...\" in the right-hand panel and enter your token in the \"Auth\" tab.\n\n## OAuth2\nDash uses OAuth 2.0 for authorisation. A good overview of OAuth 2.0 can be found [here](https://auth0.com/docs/protocols/protocol-oauth2).\n\nEndpoints: \n* https://login.dash.app/authorize\n* https://login.dash.app/oauth/token\n\nScopes to note:\n* **subdomain**: this should be set to the subdomain of the Dash the user is trying to access e.g. `subdomain:my-account`\n* **offline_access**: the standard OAuth 2.0 scope to use to obtain a refresh token\n\nAudience:\nAn query parameter of `audience=https://assetplatform.io` must be provided to the https://login.dash.app/authorize endpoint \n\nTo obtain your client ID and secret, follow the steps above to [get a temporary bearer token](#section/Authorisation/Get-a-short-lived-bearer-token-for-testing) and use this to [create custom integration settings](/dash/openapi/custom/putcustomintegrationsettings). The response you receive from the custom integrations settings endpoint will include your client ID and secret.\n\n## Authorization Code Flow\nTo begin the flow, send your user in a browser to to\n\nhttps://login.dash.app/authorize?response_type=code&audience=https://assetplatform.io&client_id={YOUR_CLIENT_ID}&redirect_uri={YOUR_REDIRECT}&scope=offline_access%20subdomain:{YOUR_SUBDOMAIN}\n\nOnce the user successfully authenticates, they will be redirected to your `redirect_uri` with the Authorization Code provided in a query parameter.\n\nNow that you have an Authorization Code, you must exchange it for your tokens via the https://login.dash.app/oauth/token endpoint.\n\n```\ncurl --request POST \\\n  --url 'https://login.dash.app/oauth/token' \\\n  --header 'content-type: application/x-www-form-urlencoded' \\\n  --data grant_type=authorization_code \\\n  --data 'client_id={YOUR_CLIENT_ID}' \\\n  --data 'client_secret={YOUR_CLIENT_SECRET}' \\\n  --data 'code={CODE_FROM_PREVIOUS_STEP}' \\\n  --data 'redirect_uri={YOUR_REDIRECT}'\n```\n\nA more detailed description of the Authorization Code Flow can be found [here](https://auth0.com/docs/get-started/authentication-and-authorization-flow/add-login-auth-code-flow)     \n  \n## Authentication Without User Interaction \n\nDue to security concerns, neither OAuth grant types `Client Credentials` or `Password` are supported by the Dash API.\n\nIf you require an automated script to call the Dash API, we recommend going through the Authorization Code Flow described above once, specifying the offline_access scope to get a refresh token along with your access token.\nYour script can store and use this refresh token to call https://login.dash.app/oauth/token and get a new access token when the current one expires.\n\n## Current User Details\nThe Bearer Token is a standard [JWT](https://jwt.io/introduction) token so can be useful to decode in some cases.\nFor example, the `sub` field of the Bearer Token can be used in cases where you need access to the `User.id` of the current user.\n\ne.g. When making an [`AssetSearch`](/dash/openapi/assets/postassetsearch) with the `STAGED_BY` criterion to find all [`Asset`](/dash/openapi/Assets) resources staged by the current user.\n\nAlternatively the [GET Current User](/dash/openapi/users/getcurrentuser) endpoint contains properties for the current user to avoid needing to decode the Bearer Token.\n\n# Permitted Actions\nIn most responses from the Dash API you will find a `permittedActions` property alongside a `result` property which contains the resource.\nThis is to provide context for operations the current user is permitted to perform on that resource.\n\nIf an expected permitted action is not included in the `permittedActions` property then the current user does not have permission to perform the action.\n\nThe [GET Current User](/dash/openapi/users/getcurrentuser) endpoint houses permitted actions which are not associated with a specific API resource instance.\ne.g. If the current user has permission to create new [`Asset`](/dash/openapi/Assets) resources then the [GET Current User](/dash/openapi/users/getcurrentuser) `permittedActions` property will contain the permitted action `ASSETS` : `CREATE_ASSETS`.\n\n# Common Use Cases\n\n## Getting fields and field options for asset metadata\n\n[`Asset.metadata`](/dash/openapi/Assets) consists of a map of `String` to `String[]`\n\nThe keys for map are [`Field`](/dash/openapi/Fields) IDs. Full details, including the field name, can be got via the [GET Field](/dash/openapi/fields/getfield) endpoint or the full list of fields for an account can be retrieved via the [GET Fields](/dash/openapi/fields/getfields) endpoint.  \n\nThe map values are a list of plain text values if [`Field.hasFixedOptions = false`](/dash/openapi/Fields) or a list of [`FieldOption`](/dash/openapi/Field-Options) IDs if [`Field.hasFixedOptions = true`](/dash/openapi/Fields)    \n\nWhere [`Field.hasFixedOptions = true`](/dash/openapi/Fields) details, including the field option name, can be got via the [GET Field Option](/dash/openapi/field-options/getfieldoption) endpoint. \n\nWhere [`Field.hierarchical = true`](/dash/openapi/Fields) the complete branch of the tree will be returned and can be constructed via the [`FieldOption.parent`](/dash/openapi/Field-Options) property.\n\n## Getting the full schema of fields and field options\nThe full list of fields for an account can be retrieved via the [GET Fields](/dash/openapi/fields/getfields) endpoint.\n\nWhere [`Field.hasFixedOptions = true`](/dash/openapi/Fields) the [POST Field Option Searches](/dash/openapi/field-options/postfieldoptionsearch) endpoint can be used to get the available options.\n\nWhere [`Field.hierarchical = true`](/dash/openapi/Fields) you should start with a `PARENT_ID` `FIELD_IS_EMPTY` query to get the top level options and then `PARENT_ID` `FIELD_EQUALS` queries to get each sub-level.  \n                   \n## Folders \nA Folder in Dash is simply a [`FieldOption`](/dash/openapi/Field-Options), for the built-in Folders [`Field`](/dash/openapi/Fields). To determine the ID of the Folders [`Field`](/dash/openapi/Fields), use the [`Folder Settings`](/dash/openapi/Folder-Settings) endpoint. Once you have this ID, Folders behave the same as any other [`Field`](/dash/openapi/Fields).\n\nFor getting the folder tree see [Getting fields and field options for asset metadata](#section/Common-Use-Cases/Getting-fields-and-field-options-for-asset-metadata) and [Getting the full schema of fields and field options](#section/Common-Use-Cases/Getting-the-full-schema-of-fields-and-field-options)\n\nFor getting assets in folders see [`AssetSearch`](/dash/openapi/assets/postassetsearch) \n\nFor getting assets in no folders see the _Search for field is empty_ example in the [POST Asset Searches](/dash/openapi/assets/postassetsearch) endpoint.\n\n## Creating a new asset\n\nAssets are the main resources in Dash. An asset consists of a file, some fixed properties (such as the date the asset was added to Dash) and custom metadata.\n\nTo create new assets and upload files:\n\n1. [Create an Asset and Upload batch job](/dash/openapi/assets/postassetanduploadbatchjob)\n2. Wait for the job to complete by checking the [GET Asset and upload batch job](/dash/openapi/assets/postassetupload/operation/getAssetAndUploadBatchJob) endpoint\n3. The completed job includes an [`AssetUpload`](/dash/openapi/assets/postassetupload) resources in the job's `result` property. For each file you want to upload:\n   * Make PUT requests to upload your file part with the byte ranges specified to the URLs in the corresponding `AssetUploadPart`.\n   * Get the `etag` property from the response of each PUT request and use them to complete the upload via the [POST Asset Upload Completion](/dash/openapi/assets/postassetuploadCompletion)\n4. The assets will be created with a [lifecycle status](/dash/openapi/Asset-Lifecycle) of `STAGED`. Use the [POST Asset lifecycle transition batch job](/dash/openapi/assets/postassetlifecycletransitionbatchjob) endpoint if you'd like to change the state of the assets (e.g. to `PENDING_APPROVAL` or `LIVE`).\n\n## Uploading a new file for an asset    \n1. Create an [`AssetUpload`](/dash/openapi/assets/postassetupload) via the [POST Asset Upload](/dash/openapi/assets/postassetupload) endpoint\n3. Make PUT requests to upload your file part with the byte ranges specified to the URLs in the corresponding `AssetUploadPart`.\n4. Get the `etag` property from the response of each PUT request and use them to complete the upload via the [POST Asset Upload Completion](/dash/openapi/assets/postassetuploadCompletion)\n\n## Getting asset file versions\nThe current [`AssetFile`](/dash/openapi/assets/getassetfiles) for an [`Asset`](/dash/openapi/Assets) is returned in the [`Asset`](/dash/openapi/Assets) resource via the [`Asset.currentFile`](/dash/openapi/Assets) property.\n\nThe [GET Asset Files](/dash/openapi/assets/getassetfiles) endpoint can be used to get all [`AssetFile`](/dash/openapi/assets/getassetfiles) resources for an [`Asset`](/dash/openapi/Assets)\n\n## Editing asset metadata    \nEdit the contents of one or more [`Asset.metadata`](/dash/openapi/Assets) map properties via the [POST Asset Metadata Edit Batch Job](/dash/openapi/assets/postassetmetadataeditbatchjob) endpoint and check on the progress and status of the edit via the [GET Asset Metadata Edit Batch Job](/dash/openapi/assets/getassetmetadataeditbatchjob) endpoint.\n\n## Getting user collections    \n1. Get the current user ID from the [current user details](#section/Authorisation/Current-User-Details)\n2. Use this ID in the `ASSOCIATED_WITH_USER` criterion of the [POST Collection Search](/dash/openapi/collections/postcollectionsearch) endpoint to get all collections a user has access to.\n3. To get the [`Asset`](/dash/openapi/Assets) resources in each collection see the _All assets in a collection_ and _Search within assets in a collection_ examples  in the [POST Asset Searches](/dash/openapi/assets/postassetsearch) endpoint for how to specify the [`Collection.id`](/dash/openapi/Collections) in a `COLLECTIONS` : `FIELD_EQUALS` criterion.\n\n## Search by file extension\nSee the _Search by file extension_ and _Search by multiple file extensions_ example in the [POST Asset Searches](/dash/openapi/assets/postassetsearch) endpoint\n\n## Searching for changed assets\nThe following date properties exist on an asset and can be supplied as FIXED field criteria in the [POST Asset Searches](/dash/openapi/assets/postassetsearch) endpoint\n\n- [`Asset.lifecycleStatus.dateStaged`](/dash/openapi/Assets) : The datetime the [`Asset`](/dash/openapi/Assets) was created but not yet live. `DATE_STAGED` in search criteria.\n- [`Asset.lifecycleStatus.datePendingApproval`](/dash/openapi/Assets) : The datetime the [`Asset`](/dash/openapi/Assets) was set for approval (if it was). `DATE_PENDING_APPROVAL` in search criteria.\n- [`Asset.lifecycleStatus.dateLive`](/dash/openapi/Assets) : The datetime the [`Asset`](/dash/openapi/Assets) was put live. `DATE_LIVE` in search criteria.\n- [`Asset.currentAssetFile.dateAdded`](/dash/openapi/Assets) : The datetime the latest [`AssetFile`](/dash/openapi/assets/getassetfiles) was added. `DATE_LAST_ASSET_FILE_ADDED` in search criteria.\n- [`Asset.dateLastModified`](/dash/openapi/Assets) : The datetime the *any* change was made to an [`Asset`](/dash/openapi/Assets). This includes all of the above and any change to custom metadata `DATE_LAST_MODIFIED` in search criteria.\n\nThere is currently no way to determine if only custom metadata has changes.\n\n# Migration from V1\n\nSeveral breaking changes have been introduced in the switch from V1 to V2, which are all the result of three changes.\n- The domain is changing from `brightdash.app` to `dash.app`.  All URLs used to access the API, including for authorisation, should be updated to the new domain.\n- The concept of \"asset staging status\" has been renamed to \"asset lifecycle\" with the introduction of the bin, which adds another state for assets that isn't just about the staging workflow.  This second change manifests in the changing of the StagingWorkflowTransitionBatchJob to the LifecycleTransitionBatchJob, a refactoring of the asset model to bring the \"date added\" and \"added by\" fields together with other lifecycle information, and the renaming of the \"date added\" and \"added by\" fields to the more specific \"date live\" and \"staged by\".\n- Asset batch jobs used to only support carrying out operations on assets by a search criterion.  This has been extended to also allow performing operations by id, so the \"criterion\" field has changed to a \"selector\" field which supports objects of either type.\n- The term `Attribute` has been renamed to `Field` throughout, to mirror the change of terminology within the Dash frontend.\n\nAll these changes are described in more specific detail below.\n\n## Domain\n- Domain has changed from `brightdash.app` to `dash.app` throughout the API.\n## Asset Staging Workflow\n- The path of this endpoint has changed from `asset-staging-workflow-transition-batch-jobs` to `asset-lifecycle-transition-batch-jobs`.\n- `criterion` in the POST body has become `selector`, and the criterion now needs to be wrapped in the following `{\"type\": \"BY_CRITERION\", \"criterion\": {...}}`.\n## Asset Searches\nFor both scroll and paged searches:\n- The following `criterion.field.fieldName` and `sorts.field.fieldName` values have been renamed:\n  - `DATE_ADDED` -> `DATE_LIVE`\n  - `ADDED_BY` -> `STAGED_BY`\n- The `stagingStatus`, `addedBy`, and `dateAdded` fields have been removed from the response. This data can now be found in the `lifecycleStatus` field.\n## Asset Deletion\n- `criterion` in the POST body has become `selector`, and the criterion now needs to be wrapped in the following `{\"type\": \"BY_CRITERION\", \"criterion\": {...}}`.\n## Asset Metadata Edit\n- `criterion` in the POST body has become `selector`, and the criterion now needs to be wrapped in the following `{\"type\": \"BY_CRITERION\", \"criterion\": {...}}`.\n## Search Filters\n- The value returned from the `searchField` field of search filter results of type `HARD_CODED_FREE_OPTION` have changed from `DATE_ADDED` to `DATE_LIVE`.  This isn't really a breaking change as the specification says this field could return any string, but it feels worth mentioning.\n## Saved Search\n- The following `criterion.field.fieldName` and `sorts.field.fieldName` values have been renamed for both POSTing and GETting SavedSearches:\n    - `DATE_ADDED` -> `DATE_LIVE`\n    - `ADDED_BY` -> `STAGED_BY`\n## Attributes/Fields\n- The string `Attribute` has been replaced with the string `Field` throughout.  This includes e.g. `AttributeOption` being renamed to `FieldOption`.  A simple find and replace should be enough to migrate.\n"}},"baseSlug":"/dash/openapi","routesMapping":{}}