HIM-public/agravity_client
HIM-public/agravity_client
5
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions
agravity_client/swagger.json

8501 lines
No EOL
262 KiB
JSON
Raw Permalink Blame History

{
"swagger": "2.0",
"info": {
"title": "Agravity OpenAPI Documentation - Public Functions",
"description": "<p>The Agravity Public API provides comprehensive access to digital asset management functionality for technical integrations, portals, and third-party applications. These endpoints are designed for programmatic access with API key authentication.</p><br/><h2>Access &amp; Security</h2><br/><b>API key is required to access these endpoints.</b><br/><ul><li>API Key Authentication - Each request requires a valid API key in headers or parameters</li><li>Portal-Aware - Many endpoints support portal context for multi-tenant scenarios</li><li>Service-to-Service Communication - Designed for backend-to-backend integrations</li><li>Stable &amp; Versioned - Public API versioning ensures backward compatibility</li></ul><h2>Core Features &amp; Operations</h2><ul><li><strong>Asset Management</strong> - Create, retrieve, update assets with full metadata support; manage versions and publish assets</li><li><strong>Collection Management</strong> - Create and organize collections hierarchically; retrieve collection type definitions and structures</li><li><strong>Asset Operations</strong> - Retrieve asset blobs (thumbnails, optimized, original); rotate and resize images; find similar assets using AI reverse search</li><li><strong>Image Editing</strong> - Apply transformations to images with advanced parameters (resize, crop, filter, color space, DPI, quality, depth)</li><li><strong>Asset Publishing</strong> - Publish assets to various targets (Vimeo, CDN); manage published asset information</li><li><strong>Asset Versioning</strong> - Create, restore, and manage asset versions; track version history with descriptions</li><li><strong>Asset Relations</strong> - Create and manage relationships between assets with hierarchical or standard relations; organize assets into logical groups</li><li><strong>Asset Relation Types</strong> - Retrieve relation type definitions including hierarchical, sequential, and unique-per-asset configurations</li><li><strong>Full-Text Search</strong> - Search assets and collections with advanced filtering, facets, and sorting capabilities</li><li><strong>Collection Sharing</strong> - Create shared collections with expiration dates, password protection, and download limits</li><li><strong>Quick Shares</strong> - Create quick share links for rapid asset sharing with expiration management</li><li><strong>Portals</strong> - Full portal management with authentication, custom theming, and asset filtering</li><li><strong>Secure Upload</strong> - Secure file upload endpoints with validation and SAS token generation</li><li><strong>Download Management</strong> - Create ZIP packages of assets with format specifications; track download progress</li><li><strong>Download Formats</strong> - Define and apply custom image transformations and optimizations for downloads</li><li><strong>Authentication</strong> - Generate SAS tokens for container write access; retrieve user information</li><li><strong>Configuration</strong> - Access frontend configuration values and system settings</li><li><strong>Helper Tools</strong> - Get searchable items, filterable items, user-defined lists, and static defined lists</li><li><strong>Translations</strong> - Retrieve translations for all entities in multiple languages</li><li><strong>Deleted Entities Tracking</strong> - Track deleted assets, collections, and other entities by date</li></ul><h2>Available Endpoints by Category</h2><ul><li><strong>Asset Management</strong> - /assets, /assets/{id}, /assetsupload</li><li><strong>Asset Relations</strong> - /assetrelations, /assetrelations/{id} (create, read, update, delete asset relationships)</li><li><strong>Asset Relation Types</strong> - /assetrelationtypes, /assetrelationtypes/{id} (retrieve relation type definitions and configurations)</li><li><strong>Asset Operations</strong> - /assets/{id}/blobs, /assets/{id}/collections, /assets/{id}/tocollection, /assets/{id}/download, /assets/{id}/resize, /assets/{id}/imageedit, /assets/{id}/availability</li><li><strong>Asset Publishing</strong> - /assets/{id}/publish, /assets/{id}/publish/{pid}</li><li><strong>Asset Versioning</strong> - /assets/{id}/versions, /assets/{id}/versionsupload, /assets/{id}/versions/{vNr}/restore</li><li><strong>AI Operations</strong> - /ai/reverseassetsearch (find similar assets using image)</li><li><strong>Collection Management</strong> - /collections, /collections/{id}, /collections/{id}/ancestors, /collections/{id}/descendants, /collections/{id}/previews, /collectionsbynames</li><li><strong>Collection Types</strong> - /collectiontypes, /collectiontypes/{id}, /collectiontypesitems</li><li><strong>Search</strong> - /search, /search/facette, /searchadmin/status</li><li><strong>Saved Searches</strong> - /savedsearches</li><li><strong>Collection Sharing</strong> - /shared/{id}, /shared/{id}/zip, /quickshares/{id}</li><li><strong>Secure Upload</strong> - /secureupload/{id}, /secureupload/{id}/upload</li><li><strong>Portal Management</strong> - /portals/{id}, /portals/{id}/config, /portals/{id}/zip, /portals/{id}/assetids, /portalsenhancetoken, /portalssaveuserattributes</li><li><strong>Authentication</strong> - /auth/containerwrite/{containerName}, /auth/inbox, /auth/users/{id}</li><li><strong>Download Formats</strong> - /downloadformats, /downloadformats-shared</li><li><strong>Configuration</strong> - /config/frontend</li><li><strong>Static Defined Lists</strong> - /staticdefinedlists, /staticdefinedlists/{id}</li><li><strong>User-Defined Lists</strong> - /helper/userdefinedlists</li><li><strong>Helper Tools</strong> - /helper/searchableitemnames, /helper/searchableitems, /helper/filterableitems</li><li><strong>Translations</strong> - /translations/{id}, /translations/{id}/{property}, /translations/{id}/custom/{customField}</li><li><strong>Web App Data</strong> - /webappdata/{id}, /data/collectiontype/{id}</li><li><strong>Workspace Management</strong> - /workspaces, /workspaces/{id}</li><li><strong>General</strong> - /version, /deleted, /durable/{instanceId}, /public/view, /signalr/negotiate</li></ul><h2>Typical Use Cases</h2><ul><li>E-commerce platforms - Product image management and dynamic optimization</li><li>Marketing automation - Asset distribution across channels with version control</li><li>Portal systems - Multi-tenant asset galleries with custom theming and permissions</li><li>Headless CMS integration - Content delivery with dynamic transformations</li><li>Mobile applications - Asset retrieval with mobile-optimized formats</li><li>AI-powered workflows - Reverse image search and automatic metadata generation</li><li>Asset sharing platforms - Secure sharing with expiration and password protection</li><li>Digital distribution - ZIP creation and bulk download management</li><li>Multi-language content - Translation management across all assets and collections</li><li>Real-time monitoring - Deletion tracking and version history auditing</li></ul><h2>Key Capabilities</h2><ul><li>Full CRUD operations on assets, collections, and related entities</li><li>Asset relationship management with hierarchical and standard relations</li><li>Advanced image transformation with ImageMagick integration</li><li>AI-powered reverse image search for asset discovery</li><li>Multi-language support with translation dictionaries</li><li>Granular permission control and role-based access</li><li>Portal creation with custom authentication and theming</li><li>Hierarchical collection organization with dynamic filtering</li><li>Real-time search with faceted navigation and advanced filtering</li><li>Secure sharing with expiration and password protection</li><li>Blob storage integration with SAS token generation</li><li>Comprehensive asset versioning and restoration</li><li>SignalR support for real-time notifications</li></ul><h2>Authentication &amp; Authorization</h2><p>All endpoints (except public share endpoints) require API key authentication. The API key can be provided:</p><ul><li>As query parameter: ?code=YOUR_API_KEY</li><li>As header: x-functions-key: YOUR_API_KEY</li></ul><p>Portal endpoints may have additional authentication methods (OAuth, Azure AD, Auth0, password) depending on portal configuration.</p><h2>Support</h2><p>For technical support or integration questions, contact <a href=\"mailto:support@agravity.io\">support@agravity.io</a> or visit <a href=\"https://agravity.io\">https://agravity.io</a>.</p><br/><p>Copyright © Agravity GmbH 2026. All Rights Reserved</p>",
"contact": {
"name": "Agravity GmbH",
"url": "https://agravity.io",
"email": "support@agravity.io"
},
"version": "10.3.0"
},
"host": "devagravitypublic.azurewebsites.net",
"basePath": "/api",
"schemes": [
"https"
],
"paths": {
"/portals/{id}": {
"get": {
"tags": [
"Public Portal Management"
],
"description": "This endpoint return the created portal by ID.",
"operationId": "HttpPortalsGetById",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "id",
"description": "The ID of the portal.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Returns on portal from database.",
"schema": {
"$ref": "#/definitions/portal"
}
},
"401": {
"description": "Unauthorized. API Key not provided."
},
"500": {
"description": "Internal server error. Please contact administrator."
}
},
"security": [
{
"function_key": []
}
]
}
},
"/portals/{id}/config": {
"get": {
"tags": [
"Public Portal Management"
],
"description": "This endpoint returns a full configuration of the portal. Incl. download formats, SDLs, UDLs, etc.",
"operationId": "HttpPortalsConfigurationGetById",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "id",
"description": "The ID of the portal.",
"required": true,
"type": "string"
},
{
"in": "query",
"name": "translations",
"description": "When default language should be returned and the translation dictionary is delivered. (Ignores the \"Accept-Language\" header)",
"type": "boolean"
},
{
"in": "header",
"name": "Accept-Language",
"description": "The requested language of the response. If not matching it falls back to default language.",
"type": "string"
}
],
"responses": {
"200": {
"description": "Returns a full configuration of a portal.",
"schema": {
"$ref": "#/definitions/portalConfiguration"
}
},
"401": {
"description": "Unauthorized. API Key not provided."
},
"500": {
"description": "Internal server error. Please contact administrator."
}
},
"security": [
{
"function_key": []
}
]
}
},
"/portalsenhancetoken": {
"post": {
"tags": [
"Public Portal Management"
],
"description": "This endpoint saves the portal user and returns CustomClaimsProviderResponseContentTokenIssuanceStart which is used to enhance the token with user context,...",
"operationId": "HttpPortalsEnhanceToken",
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Returns CustomClaimsProviderResponseContentTokenIssuanceStart.",
"schema": {
"$ref": "#/definitions/customClaimsProviderResponseContentTokenIssuanceStart"
}
},
"401": {
"description": "Unauthorized. API Key not provided."
},
"500": {
"description": "Internal server error. Please contact administrator."
}
},
"security": [
{
"function_key": []
}
]
}
},
"/portalssaveuserattributes": {
"post": {
"tags": [
"Public Portal Management"
],
"description": "This endpoint saves the portal user attributes",
"operationId": "HttpPortalsSavePortalUserAttributes",
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Returns CustomClaimsProviderResponseContentAttributeCollectionSubmit",
"schema": {
"$ref": "#/definitions/customClaimsProviderResponseContentAttributeCollectionSubmit"
}
},
"401": {
"description": "Unauthorized. API Key not provided."
},
"500": {
"description": "Internal server error. Please contact administrator."
}
},
"security": [
{
"function_key": []
}
]
}
},
"/portals/{id}/zip": {
"post": {
"tags": [
"Public Portal Management"
],
"description": "Initiates the ZIP creation of an asset basket from an portal.",
"operationId": "HttpPortalRequestZipById",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "id",
"description": "The ID of the portal.",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body",
"description": "The allowed formats are the input which could be added.",
"required": true,
"schema": {
"$ref": "#/definitions/downloadZipRequest"
}
}
],
"responses": {
"201": {
"description": "Returns the portal with the given ID.",
"schema": {
"$ref": "#/definitions/downloadZipRequest"
}
},
"400": {
"description": "Not valid portal id! (Code: 00b410fe-97d1-4952-ba0b-327d22514934)<br>Object is not a valid DownloadZipRequest. (Code: a51d1697-f56e-4fa3-bde8-3ab44e6cbb0a)<br>No allowed formats are given! (Code: 684df4b1-e0c5-4b07-8c81-cb9835e0bd00)<br>No asset ids are given! (Code: e8361816-fcc9-48b9-99d4-2133dfed7721)<br>Not all asset ids are valid! (Code: 0619480f-fa10-4c45-a60d-cb269d8be7b4)<br>Portal not found in database! (Code: 50a49113-cbcf-470c-ab8c-098dcd23cd0f)<br>Not all allowed formats are in the portal allowed formats! (Code: c679981e-fbaa-4941-90aa-3b99b1d5a748)<br>Not all asset ids are valid for this portal! (Code: 01e22b3a-13f9-4d5a-a777-2c69ce7b5b05)<br>No matching allowed formats for requested assets. (Code: bd27176f-9a4d-44ac-9055-9359b405558e)<br>Not all asset types have an allowed format in this request! (Code: 2289c7b1-0351-4815-b280-ce4628bdb3dd)<br>Error on upsert zipRequest in database - max retry count is reached. (Code:7a627b8f-11f8-4bbb-bcbd-9f6f5726557a)",
"schema": {
"$ref": "#/definitions/agravityErrorResponse"
}
},
"404": {
"description": "Portal not found. (Code: 87d09a21-14d6-4da4-ab69-01e6c87f108c)<br>",
"schema": {
"$ref": "#/definitions/agravityErrorResponse"
}
},
"401": {
"description": "Unauthorized. API Key not provided."
},
"500": {
"description": "Internal server error. Please contact administrator."
}
},
"security": [
{
"function_key": []
}
]
}
},
"/portals/{id}/zip/{zipId}": {
"get": {
"tags": [
"Public Portal Management"
],
"description": "This endpoint gets the progress/status of the ZIP creation of a portal.",
"operationId": "HttpPortalGetStatusZipById",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "id",
"description": "The ID of the zip request collection.",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "zipId",
"description": "The ID of the requested zip.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Returns the zip request for a portal with the given ID.",
"schema": {
"$ref": "#/definitions/downloadZipStatus"
}
},
"400": {
"description": "Not valid zip request id! (Code: 15331af9-82d6-41ba-a015-47c23f864eec)<br>Zip request is no longer available! (Code: 18b7b4aa-6b4a-4da4-b8b3-c7ab1381e28c)",
"schema": {
"$ref": "#/definitions/agravityErrorResponse"
}
},
"401": {
"description": "Unauthorized. API Key not provided."
},
"500": {
"description": "Internal server error. Please contact administrator."
}
},
"security": [
{
"function_key": []
}
]
}
},
"/portals/{id}/assetids": {
"get": {
"tags": [
"Public Portal Management"
],
"description": "This endpoint gets all Asset IDs in portal scope.",
"operationId": "HttpPortalGetAllAssetIdsById",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "id",
"description": "The ID of the portal.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Returns all Asset IDs in scope of the portal.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"400": {
"description": "Portal ID is mandatory and not valid. (Code: f2817cb8-8573-4205-b45d-1b9a7f3d8cbb)",
"schema": {
"$ref": "#/definitions/agravityErrorResponse"
}
},
"401": {
"description": "Unauthorized. API Key not provided."
},
"404": {
"description": "The requested item could not be found."
},
"500": {
"description": "Internal server error. Please contact administrator."
}
},
"security": [
{
"function_key": []
}
]
}
},
"/ai/reverseassetsearch": {
"post": {
"tags": [
"Public AI Operations"
],
"description": "This endpoint allows to use one asset which is used for searching similar assets.",
"operationId": "HttpReverseAssetSearch",
"consumes": [
"multipart/form-data"
],
"produces": [
"application/json"
],
"parameters": [
{
"in": "header",
"name": "Accept-Language",
"description": "The requested language of the response. If not matching it falls back to default language.",
"type": "string"
},
{
"name": "name",
"description": "",
"type": "string",
"in": "formData"
},
{
"name": "collectionid",
"description": "",
"type": "string",
"in": "formData"
},
{
"name": "file",
"description": "",
"type": "file",
"in": "formData"
},
{
"name": "filename",
"description": "",
"type": "string",
"in": "formData"
},
{
"name": "previewof",
"description": "",
"type": "string",
"in": "formData"
}
],
"responses": {
"200": {
"description": "Returns a list of similar Assets.",
"schema": {
"$ref": "#/definitions/searchResult"
}
},
"400": {
"description": "Reverse Asset search failed. Query Asset Content length is insuffient (0 or too big). (Code: 76695187-7ace-4a2e-9fd2-7f0170a998d9)<br>Wrong content media type for Query Asset.Please upload file with multipart/form-data. (Code: 5ab68591-c21e-4cd7-8d00-01c13bfbb384)<br>Could not find file in multi-part data. (Code: cbdb4838-fab5-48b3-a8de-ac591316c904)<br>File type is not supported for reverse Asset search. (Code: 1dba4d87-6162-40b9-9076-2d56af6bcdbe)<br>",
"schema": {
"$ref": "#/definitions/agravityErrorResponse"
}
},
"401": {
"description": "Unauthorized. API Key not provided."
},
"403": {
"description": "Not enough privileges to access item."
},
"500": {
"description": "Internal server error. Please contact administrator."
}
},
"security": [
{
"function_key": []
}
]
}
},
"/assets/{id}/blobs": {
"get": {
"tags": [
"Public Asset Operations"
],
"description": "This endpoint checks, if an asset exists and returns the url for the requested blob.",
"operationId": "HttpGetAssetBlob",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "id",
"description": "The ID of the asset.",
"required": true,
"type": "string"
},
{
"in": "query",
"name": "c",
"description": "\"t\" for thumbnail (default); \"op\" for optimized; \"os\" for original size; \"o\" for original.",
"required": true,
"type": "string"
},
{
"in": "query",
"name": "portal_id",
"description": "If the request comes from portal this is the indicator. If used the \"key\" param becomes mandatory.",
"type": "string"
},
{
"in": "query",
"name": "key",
"description": "The key is the MD5 hash of the original blob of the asset.",
"type": "string"
}
],
"responses": {
"200": {
"description": "This function checks if asset exist on storage and returns the asset blob (incl. url).",
"schema": {
"$ref": "#/definitions/assetBlob"
}
},
"401": {
"description": "Unauthorized. API Key not provided."
},
"404": {
"description": "The requested item could not be found."
},
"500": {
"description": "Internal server error. Please contact administrator."
}
},
"security": [
{
"function_key": []
}
]
}
},
"/assets/{id}/blob": {
"get": {
"tags": [
"Public Asset Operations"
],
"description": "This endpoint checks, if an asset exists, is an image, has original blob, is status active, is part of the shared collection and returns the requested asset blob.",
"operationId": "HttpGetSharedAssetBlob",
"produces": [
"application/json"
],
"parameters": [
{
"in": "query",
"name": "share_id",
"description": "This share ID is like an API key. Check on validy (format, expire, collection still availabe). Otherwise StatusCode 403 (Forbidden) is returned.",
"required": true,
"type": "string"
},
{
"in": "header",
"name": "ay-password",
"description": "If shared collection has a password, this header is mandatory. Otherwise StatusCode 403 (Forbidden) is returned.",
"type": "string"
},
{
"in": "path",
"name": "id",
"description": "The ID of the asset.",
"required": true,
"type": "string"
},
{
"in": "query",
"name": "format",
"description": "Which download format the blob is requested.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Returns the asset blob (incl. URL) for the requested asset according to the input parameter(s)",
"schema": {
"$ref": "#/definitions/assetBlob"
}
},
"400": {
"description": "Asset has to be image! Not allowed on type (Code: ec482f52-0ec8-4a8b-89fd-65b9d6b624cd)",
"schema": {
"$ref": "#/definitions/agravityErrorResponse"
}
},
"404": {
"description": "The requested item could not be found."
},
"500": {
"description": "Internal server error. Please contact administrator."
}
}
}
},
"/assets/{id}/collections": {
"get": {
"tags": [
"Public Asset Operations"
],
"description": "Returns all collections of a specific asset.",
"operationId": "HttpGetAssetCollectionsById",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "id",
"description": "The ID of the asset.",
"required": true,
"type": "string"
},
{
"in": "query",
"name": "fields",
"description": "This limits the fields which are returned, separated by comma (',').",
"type": "string"
},
{
"in": "query",
"name": "translations",
"description": "When default language should be returned and the translation dictionary is delivered. (Ignores the \"Accept-Language\" header)",
"type": "boolean"
},
{
"in": "header",
"name": "Accept-Language",
"description": "The requested language of the response. If not matching it falls back to default language.",
"type": "string"
}
],
"responses": {
"200": {
"description": "Returns all collections of a specific asset.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/collection"
}
}
},
"401": {
"description": "Unauthorized. API Key not provided."
},
"404": {
"description": "The requested item could not be found."
}
},
"security": [
{
"function_key": []
}
]
}
},
"/assets/{id}/tocollection": {
"post": {
"tags": [
"Public Asset Operations"
],
"description": "This endpoint allows to move/assign from/to another collection with the given operation parameter.",
"operationId": "HttpAssetToCollection",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "id",
"description": "The ID of the asset.",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body",
"description": "Contains information about this operation.",
"required": true,
"schema": {
"$ref": "#/definitions/moveCollectionBody"
}
}
],
"responses": {
"400": {
"description": "Internal error. Request or Database client are null. (Code: 21814e91-379c-4c35-8ff9-974147ba6b76)",
"schema": {
"$ref": "#/definitions/agravityErrorResponse"
}
},
"401": {
"description": "Unauthorized. API Key not provided."
},
"204": {
"description": "Moves/assigns a single asset from/to collection with the given operation parameter."
},
"404": {
"description": "The requested item could not be found."
},
"500": {
"description": "Internal server error. Please contact administrator."
}
},
"security": [
{
"function_key": []
}
]
}
},
"/assets/{id}/download": {
"get": {
"tags": [
"Public Asset Operations"
],
"description": "This endpoint is similar to GetAssetBlob but with ContentDistribution and filename to let browser download the content.",
"operationId": "HttpGetAssetDownload",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "id",
"description": "The ID of the asset.",
"required": true,
"type": "string"
},
{
"in": "query",
"name": "c",
"description": "\"t\" for thumbnail (default); \"op\" for optimized; \"os\" for original size; \"o\" for original.",
"type": "string"
},
{
"in": "query",
"name": "f",
"description": "(optional) provide the id of any valid download format.",
"type": "string"
},
{
"in": "query",
"name": "portal_id",
"description": "If the request comes from portal this is the indicator. It will be checked if the requested blob is valid for the portal.",
"type": "string"
},
{
"in": "query",
"name": "key",
"description": "The key is the MD5 hash of the original blob of the asset.",
"type": "string"
}
],
"responses": {
"200": {
"description": "This function checks if asset exist on storage and returns the asset blob (incl. url to download).",
"schema": {
"$ref": "#/definitions/assetBlob"
}
},
"401": {
"description": "Unauthorized. API Key not provided."
},
"404": {
"description": "The requested item could not be found."
},
"500": {
"description": "Internal server error. Please contact administrator."
}
},
"security": [
{
"function_key": []
}
]
}
},
"/assets/{id}/resize": {
"get": {
"tags": [
"Public Asset Operations"
],
"description": "This endpoint lets you resize/modify the image asset according to the given parameter(s).",
"operationId": "HttpAssetResize",
"produces": [
"image/xyz",
"application/json"
],
"parameters": [
{
"in": "path",
"name": "id",
"description": "The ID of the asset.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Returns the resized/modified image according to the input parameter(s)",
"schema": {
"format": "binary",
"type": "string"
}
},
"400": {
"description": "Asset has to be image! Not allowed on type (Code: ec482f52-0ec8-4a8b-89fd-65b9d6b624cd)",
"schema": {
"$ref": "#/definitions/agravityErrorResponse"
}
},
"401": {
"description": "Unauthorized. API Key not provided."
},
"404": {
"description": "The requested item could not be found."
},
"500": {
"description": "Internal server error. Please contact administrator."
}
},
"security": [
{
"function_key": []
}
]
}
},
"/assets/{id}/imageedit": {
"get": {
"tags": [
"Public Asset Operations"
],
"description": "This endpoint lets you resize/modify the image asset according to the given parameter(s).",
"operationId": "HttpAssetImageEdit",
"produces": [
"image/xyz",
"application/json"
],
"parameters": [
{
"in": "path",
"name": "id",
"description": "The ID of the asset.",
"required": true,
"type": "string"
},
{
"in": "query",
"name": "width",
"description": "The width of the final image.",
"type": "integer",
"format": "int32"
},
{
"in": "query",
"name": "height",
"description": "The height of the final image.",
"type": "integer",
"format": "int32"
},
{
"in": "query",
"name": "mode",
"description": "The supported modes: contain (default), cover, fill, crop, none",
"type": "string"
},
{
"in": "query",
"name": "target",
"description": "The file type which the image should be (i.e. webp, png, jpg, gif)",
"type": "string"
},
{
"in": "query",
"name": "bgcolor",
"description": "The color of the background color if background is visible (crop outside, png). RGB(A) in hex code (i.e. 00FFAA or with alpha channel: 44AABB77) and color names (i.e. lightgray) supported - default: transparent",
"type": "string"
},
{
"in": "query",
"name": "dpi",
"description": "The density (counts for X and Y) of the target image.",
"type": "integer",
"format": "int32"
},
{
"in": "query",
"name": "depth",
"description": "The bit depth of the target image.",
"type": "integer",
"format": "int32"
},
{
"in": "query",
"name": "quality",
"description": "The quality of the target image (1-100).",
"type": "integer",
"format": "int32"
},
{
"in": "query",
"name": "colorspace",
"description": "The color space of the image (Default: sRGB).",
"type": "string"
},
{
"in": "query",
"name": "crop_x",
"description": "If mode is crop: The x coordinate of the point (if image is extended (outside) it is negative)",
"type": "integer",
"format": "int32"
},
{
"in": "query",
"name": "crop_y",
"description": "If mode is crop: The y coordinate of the point (if image is extended (outside) it is negative)",
"type": "integer",
"format": "int32"
},
{
"in": "query",
"name": "crop_width",
"description": "If mode=crop: The width of the cropping rectangle (from original pixel)",
"type": "integer",
"format": "int32"
},
{
"in": "query",
"name": "crop_height",
"description": "If mode=crop: The height of the cropping rectangle (from original pixel)",
"type": "integer",
"format": "int32"
},
{
"in": "query",
"name": "filter",
"description": "Which filter should be applied. To get all filters available use: /api/helper/imageeditfilters",
"type": "string"
},
{
"in": "query",
"name": "original",
"description": "If set to true the internal image is used instead of the default original",
"type": "boolean"
}
],
"responses": {
"200": {
"description": "Returns the resized/modified image according to the input parameter(s)",
"schema": {
"format": "binary",
"type": "string"
}
},
"400": {
"description": "Asset has to be image! Not allowed on type (Code: ec482f52-0ec8-4a8b-89fd-65b9d6b624cd)<br>Asset does not have origsize or optimized blob reference. (Code: b6733be7 -8560-4b1a-8dfc-657ac668ffea)",
"schema": {
"$ref": "#/definitions/agravityErrorResponse"
}
},
"401": {
"description": "Unauthorized. API Key not provided."
},
"404": {
"description": "The requested item could not be found."
},
"500": {
"description": "Internal server error. Please contact administrator."
}
},
"security": [
{
"function_key": []
}
]
},
"post": {
"tags": [
"Public Asset Operations"
],
"description": "This endpoint lets you use the entire api of Imagemagick to edit the image.",
"operationId": "HttpImageDynamicEdit",
"consumes": [
"application/json"
],
"produces": [
"image/xyz",
"application/json"
],
"parameters": [
{
"in": "path",
"name": "id",
"description": "The ID of the asset.",
"required": true,
"type": "string"
},
{
"in": "query",
"name": "target_filename",
"description": "If the file should have a specific naming.",
"type": "string"
},
{
"in": "body",
"name": "body",
"description": "Operations to be performed on the image directly mapped to c# imagemagick sdk",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/dynamicImageOperation"
}
}
}
],
"responses": {
"200": {
"description": "Returns the resized/modified image according to the input parameter(s)",
"schema": {
"format": "binary",
"type": "string"
}
},
"400": {
"description": "Asset has to be image! Not allowed on type: {type} (Code: ec482f52-0ec8-4a8b-89fd-65b9d6b624cd)<br>Not a valid asset used. It has to be an asset, not deleted and from type {type} (Code: 320cda1c-7dd8-4b23-9b59-51ccee5e0a98)<br>",
"schema": {
"$ref": "#/definitions/agravityErrorResponse"
}
},
"401": {
"description": "Unauthorized. API Key not provided."
},
"404": {
"description": "The requested item could not be found."
},
"500": {
"description": "Internal server error. Please contact administrator."
}
},
"security": [
{
"function_key": []
}
]
}
},
"/assets/{id}/imageedit/{download_format_id}": {
"get": {
"tags": [
"Public Asset Operations"
],
"description": "This endpoint returns an image with the requested download format applied.",
"operationId": "HttpImageDynamicGetFromDownloadId",
"produces": [
"image/xyz",
"application/json"
],
"parameters": [
{
"in": "path",
"name": "id",
"description": "The ID of the asset.",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "download_format_id",
"description": "The ID of the download format.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Returns the resized/modified image according to the input parameter(s)",
"schema": {
"format": "binary",
"type": "string"
}
},
"400": {
"description": "Asset has to be image! Not allowed on type: {type} (Code: ec482f52-0ec8-4a8b-89fd-65b9d6b624cd)<br>The ID given is missing or not a valid download format ID. (Code: 7ec8d75d-3da4-4dce-8ab2-e52f0cf5f1f1)<br>Not a valid asset used. It has to be an asset, not deleted and from type {type} (Code: 320cda1c-7dd8-4b23-9b59-51ccee5e0a98)<br>Could not find requested download format. (Code: 05985771-df5e-4620-9b58-785177a1b223)<br>",
"schema": {
"$ref": "#/definitions/agravityErrorResponse"
}
},
"401": {
"description": "Unauthorized. API Key not provided."
},
"404": {
"description": "The requested item could not be found."
},
"500": {
"description": "Internal server error. Please contact administrator."
}
},
"security": [
{
"function_key": []
}
]
}
},
"/assets/{id}/availability": {
"put": {
"tags": [
"Public Asset Operations"
],
"description": "This endpoint sets the availability of the asset. All properties are put on the asset and replace previous values.To make an asset unavailable set the `availability` property to 'locked' or set the `available_from` property below the current date. To make it available set empty string to `availability` property or `available_to` property into past.",
"operationId": "HttpPutAssetAvailability",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "id",
"description": "The ID of the asset.",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body",
"description": "The values are validated and put directly on the asset.",
"required": true,
"schema": {
"$ref": "#/definitions/assetAvailability"
}
}
],
"responses": {
"200": {
"description": "The values are return which are put on the asset.",
"schema": {
"$ref": "#/definitions/assetAvailability"
}
},
"400": {
"description": "Could not parse the asset availability object. (Code: 85ba8328-9181-4d74-a326-4073b17346d8)<br>Object is not a valid asset availability object. (Code: 5515ebe5-2751-4760-a864-47812126b9a1)<br>Asset availability has a confusing state: {updated.Availability}. (Code: 5515ebe5-2751-4760-a864-47812126b9a1)<br>Ambiguous information: Asset available_from can not be greater or equal as available_to when asset should be available.(Code: 16338bcd-614c-4322-a164-e3112d622392 )<br>Ambiguous information: Asset available_from can not be less or equal as available_to when asset should be locked and is not in the future. (Code: 092ddb50-2af8-49a1-b005-68c9d5c600d1)<br>Error on upsert asset availability in database - max retry count is reached. (Code: 98a80b23-bf8d-4cc1-ad6c-08cd69214dcd) <br>",
"schema": {
"$ref": "#/definitions/agravityErrorResponse"
}
},
"401": {
"description": "Unauthorized. API Key not provided."
},
"500": {
"description": "Internal server error. Please contact administrator."
}
},
"security": [
{
"function_key": []
}
]
}
},
"/assets/{id}/relations": {
"get": {
"tags": [
"Public Asset Operations"
],
"description": "This endpoint returns the asset relations",
"operationId": "HttpGetAssetRelationsById",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "id",
"description": "The ID of the asset.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Returns the asset relations for this specific asset.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/assetRelation"
}
}
},
"401": {
"description": "Unauthorized. API Key not provided."
},
"404": {
"description": "The requested item could not be found."
}
},
"security": [
{
"function_key": []
}
]
}
},
"/assetrelations": {
"post": {
"tags": [
"Public Asset Relation Management"
],
"description": "This endpoint creates one asset relation entry in the database.",
"operationId": "HttpAssetRelationCreate",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"in": "query",
"name": "translations",
"description": "When default language should be returned and the translation dictionary is delivered. (Ignores the \"Accept-Language\" header)",
"type": "boolean"
},
{
"in": "header",
"name": "Accept-Language",
"description": "The requested language of the response. If not matching it falls back to default language.",
"type": "string"
},
{
"in": "query",
"name": "assetrelationtypeid",
"description": "The ID of the asset relation type, where these asset relations should come from.",
"type": "string"
},
{
"in": "body",
"name": "body",
"description": "This endpoint creates an asset relation in the database.",
"required": true,
"schema": {
"$ref": "#/definitions/assetRelation"
}
}
],
"responses": {
"201": {
"description": "Returns the created asset relation.",
"schema": {
"$ref": "#/definitions/assetRelation"
}
},
"400": {
"description": "Object is not a valid asset_relation. (Code: db336702-2654-4c87-8a17-38994ef5f812)<br>No input object given. (Code: 24897b5c-4322-4303-af28-578f374a17a0)<br>Not valid asset relation id! (Code: d5b66c4d-209a-4fe7-a4fc-2c36a86e8a6d)<br>Can not create asset relation with id {input.Id}. Asset Relation already exists. Delete first. (Code: 15964d55-b903-4120-8d83-bec54bd26e40)<br>Missing or invalid parameter \"assetrelationtypeid\" (Code: a0a5b486-972b-44c2-9378-96fc437c91ad)<br>Asset relation type not found. (Code: 33766cf4-d135-452b-9767-eb2171c5f258)<br>Asset relation must have at least two different assets. (Code: 5519ac52-aac3-49e4-9cde-925b1ac4e691)<br>Asset with ID {assetId} not found. (Code: 4fc224fb-6e5f-4ca0-b93d-f693a223a740)<br>The user does not have editor permission on all assets in the relation. (Code: 5179e72a-a72e-4731-a476-2de784703315)<br>For hierarchical relations, exactly one asset must be marked as parent. (Code: 1a9d8c7b-6e5f-3a2d-1b8c-7e6f5d4a3b2c)<br>Error on create asset relation in database - max retry count is reached. (Code: 7af65a99-32d8-4e98-b96b-00cd8649fc53)<br>The user does not have editor permission on the relation type. (Code: 63cad31c-ed36-4e1e-add4-349782019b68)<br>The asset relation contains assets that are already part of another relation of the same type. (Code: d3a34fc8-e658-487f-b224-5da2d0843ee1)",
"schema": {
"$ref": "#/definitions/agravityErrorResponse"
}
},
"401": {
"description": "Unauthorized. API Key not provided."
},
"500": {
"description": "Internal server error. Please contact administrator."
}
},
"security": [
{
"function_key": []
}
]
},
"get": {
"tags": [
"Public Asset Relation Management"
],
"description": "This endpoint lists all asset relations in database.",
"operationId": "HttpAssetRelationGetAll",
"produces": [
"application/json"
],
"parameters": [
{
"in": "query",
"name": "assetrelationtypeid",
"description": "The ID of the asset relation type, where these asset relations should come from.",
"type": "string"
},
{
"in": "header",
"name": "Accept-Language",
"description": "The requested language of the response. If not matching it falls back to default language.",
"type": "string"
},
{
"in": "query",
"name": "translations",
"description": "When default language should be returned and the translation dictionary is delivered. (Ignores the \"Accept-Language\" header)",
"type": "boolean"
}
],
"responses": {
"200": {
"description": "Returns all asset relations in database.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/assetRelation"
}
}
},
"400": {
"description": "Invalid parameter \"assetrelationtypeid\". (Code: 16e4697f-5ba6-4dea-a51a-c2e08eff5faa)<br>Asset relation type not found. (Code: 33766cf4-d135-452b-9767-eb2171c5f258)",
"schema": {
"$ref": "#/definitions/agravityErrorResponse"
}
},
"401": {
"description": "Unauthorized. API Key not provided."
},
"500": {
"description": "Internal server error. Please contact administrator."
}
},
"security": [
{
"function_key": []
}
]
}
},
"/assetrelations/{id}": {
"post": {
"tags": [
"Public Asset Relation Management"
],
"description": "This endpoint updates an asset relation entry in the database.",
"operationId": "HttpAssetRelationUpdateById",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "id",
"description": "The ID of the asset relation.",
"required": true,
"type": "string"
},
{
"in": "query",
"name": "translations",
"description": "When default language should be returned and the translation dictionary is delivered. (Ignores the \"Accept-Language\" header)",
"type": "boolean"
},
{
"in": "header",
"name": "Accept-Language",
"description": "The requested language of the response. If not matching it falls back to default language.",
"type": "string"
},
{
"in": "body",
"name": "body",
"description": "This endpoint updates an asset relation with ID in the database.",
"required": true,
"schema": {
"$ref": "#/definitions/assetRelation"
}
}
],
"responses": {
"200": {
"description": "Returns the updated asset relation.",
"schema": {
"$ref": "#/definitions/assetRelation"
}
},
"400": {
"description": "Object is not a valid asset_relation. (Code: 6c5b4a9d-8e7f-3a2d-1b8c-7e6f5d4a3b2c)<br>No input object given. (Code: 5b4a9d8c-7e6f-3a2d-1b8c-7e6f5d4a3b2c)<br>Asset relation must have at least two different assets. (Code: 4a9d8c7b-6e5f-3a2d-1b8c-7e6f5d4a3b2c)<br>Asset with ID {assetId} not found. (Code: 3a9d8c7b-6e5f-3a2d-1b8c-7e6f5d4a3b2c)<br>The user does not have editor permission on all assets in the relation. (Code: 2a9d8c7b-6e5f-3a2d-1b8c-7e6f5d4a3b2c)<br>For hierarchical relations, exactly one asset must be marked as parent. (Code: 1a9d8c7b-6e5f-3a2d-1b8c-7e6f5d4a3b2c)<br>The user does not have editor permission on the relation type. (Code: 63cad31c-ed36-4e1e-add4-349782019b68)<br>The asset relation contains assets that are already part of another relation of the same type. (Code: b08c7606-ff7d-4b81-90ad-5d94f32cb7be)",
"schema": {
"$ref": "#/definitions/agravityErrorResponse"
}
},
"401": {
"description": "Unauthorized. API Key not provided."
},
"404": {
"description": "The requested item could not be found."
},
"500": {
"description": "Internal server error. Please contact administrator."
}
},
"security": [
{
"function_key": []
}
]
},
"get": {
"tags": [
"Public Asset Relation Management"
],
"description": "This endpoint gets a single asset relation.",
"operationId": "HttpAssetRelationGetById",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "id",
"description": "The ID of the asset relation.",
"required": true,
"type": "string"
},
{
"in": "query",
"name": "translations",
"description": "When default language should be returned and the translation dictionary is delivered. (Ignores the \"Accept-Language\" header)",
"type": "boolean"
}
],
"responses": {
"200": {
"description": "Returns the requested asset relation.",
"schema": {
"$ref": "#/definitions/assetRelation"
}
},
"400": {
"description": "Asset relation type not found. (Code: 33766cf4-d135-452b-9767-eb2171c5f258)<br>The user does not have editor permission on the relation type. (Code: 63cad31c-ed36-4e1e-add4-349782019b68)",
"schema": {
"$ref": "#/definitions/agravityErrorResponse"
}
},
"401": {
"description": "Unauthorized. API Key not provided."
},
"404": {
"description": "The requested item could not be found."
},
"500": {
"description": "Internal server error. Please contact administrator."
}
},
"security": [
{
"function_key": []
}
]
},
"delete": {
"tags": [
"Public Asset Relation Management"
],
"description": "This endpoint deletes a single asset relation.",
"operationId": "HttpAssetRelationDeleteById",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "id",
"description": "The ID of the asset relation.",
"required": true,
"type": "string"
}
],
"responses": {
"400": {
"description": "Error on deleting asset relation ({id}) database - max retry count is reached. (Code: 9d8c7b6a-5e4f-3a2d-1b8c-7e6f5d4a3b2c)<br>Asset relation type not found. (Code: 33766cf4-d135-452b-9767-eb2171c5f258)<br>The user does not have editor permission on the relation type. (Code: 3da4bd72-e810-46e5-a4ee-8fa2bd2dce32)",
"schema": {
"$ref": "#/definitions/agravityErrorResponse"
}
},
"401": {
"description": "Unauthorized. API Key not provided."
},
"204": {
"description": "The delete operation of the asset relation with the given ID was successful."
},
"404": {
"description": "The requested item could not be found."
},
"500": {
"description": "Internal server error. Please contact administrator."
}
},
"security": [
{
"function_key": []
}
]
}
},
"/assetrelationtypes": {
"get": {
"tags": [
"Public Asset Relation Type Management"
],
"description": "This endpoint lists all asset relation types in database.",
"operationId": "HttpAssetRelationTypeGetAll",
"produces": [
"application/json"
],
"parameters": [
{
"in": "query",
"name": "translations",
"description": "When default language should be returned and the translation dictionary is delivered. (Ignores the \"Accept-Language\" header)",
"type": "boolean"
},
{
"in": "header",
"name": "Accept-Language",
"description": "The requested language of the response. If not matching it falls back to default language.",
"type": "string"
}
],
"responses": {
"200": {
"description": "Returns all asset relation types in database.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/assetRelationType"
}
}
},
"401": {
"description": "Unauthorized. API Key not provided."
},
"500": {
"description": "Internal server error. Please contact administrator."
}
},
"security": [
{
"function_key": []
}
]
}
},
"/assetrelationtypes/{id}": {
"get": {
"tags": [
"Public Asset Relation Type Management"
],
"description": "This endpoint gets a single asset relation type.",
"operationId": "HttpAssetRelationTypeGetById",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "id",
"description": "The ID of the asset relation type.",
"required": true,
"type": "string"
},
{
"in": "query",
"name": "translations",
"description": "When default language should be returned and the translation dictionary is delivered. (Ignores the \"Accept-Language\" header)",
"type": "boolean"
},
{
"in": "header",
"name": "Accept-Language",
"description": "The requested language of the response. If not matching it falls back to default language.",
"type": "string"
}
],
"responses": {
"200": {
"description": "Returns the requested asset relation type.",
"schema": {
"$ref": "#/definitions/assetRelationType"
}
},
"401": {
"description": "Unauthorized. API Key not provided."
},
"404": {
"description": "If the asset relation type with the ID was not found."
},
"500": {
"description": "Internal server error. Please contact administrator."
}
},
"security": [
{
"function_key": []
}
]
}
},
"/assets": {
"post": {
"tags": [
"Public Asset Management"
],
"description": "This endpoint creates one asset entry in the database.",
"operationId": "HttpAssetsCreate",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"in": "query",
"name": "collectionid",
"description": "The ID of the collection where this assets should be assigned.",
"required": true,
"type": "string"
},
{
"in": "query",
"name": "translations",
"description": "When default language should be returned and the translation dictionary is delivered. (Ignores the \"Accept-Language\" header)",
"type": "boolean"
},
{
"in": "header",
"name": "Accept-Language",
"description": "The requested language of the response. If not matching it falls back to default language.",
"type": "string"
},
{
"in": "body",
"name": "body",
"description": "This endpoint creates an unique asset ID and adds the information to the database.",
"required": true,
"schema": {
"$ref": "#/definitions/asset"
}
}
],
"responses": {
"201": {
"description": "Returns the created simple asset.",
"schema": {
"$ref": "#/definitions/asset"
}
},
"400": {
"description": "A parameter is null. (Code: 8f9036ff-037d-49a1-aab2-57899e5d30e6)<br>Given asset body is not valid. (Code: a51d1697-f56e-4fa3-bde8-3ab44e6cbb0a)<br>Asset availability has a confusing state: {updated.Availability}. (Code: 5515ebe5-2751-4760-a864-47812126b9a1)<br>Ambiguous information: Asset available_from can not be greater or equal as available_to when asset should be available.(Code: 16338bcd-614c-4322-a164-e3112d622392 )<br>Ambiguous information: Asset available_from can not be less or equal as available_to when asset should be locked and is not in the future. (Code: 092ddb50-2af8-49a1-b005-68c9d5c600d1)<br>Not valid asset id. (Code: b2409333-b6d4-4efc-b21e-56c1db9e9d25)<br>Can not create asset with id {input.Id}. Asset already exists. Delete first. (Code: ef721e67-6d4b-4e60-81cf-4be8f14581eb)<br>Error on creating custom items on asset. (Code: 4e780f21-17fc-4125-a9d8-2cf0c23d84d6)",
"schema": {
"$ref": "#/definitions/agravityErrorResponse"
}
},
"401": {
"description": "Unauthorized. API Key not provided."
},
"500": {
"description": "Internal server error. Please contact administrator."
}
},
"security": [
{
"function_key": []
}
]
},
"get": {
"tags": [
"Public Asset Management"
],
"description": "This endpoint lists all the assets, which are stored in the database and not deleted (status \"A\")",
"operationId": "HttpAssetsGet",
"produces": [
"application/json"
],
"parameters": [
{
"in": "query",
"name": "collectionid",
"description": "The ID of the collection where these assets should come from. (Is not required when 'collectiontypeid' is set.)",
"type": "string"
},
{
"in": "query",
"name": "collectiontypeid",
"description": "The ID of the collection type where these assets should come from. (Is not required when 'collectionid' is set.) CAUTION: The assets returned are not distinct => Duplicates are possible if assets are in multiple collections in this collection type!",
"type": "string"
},
{
"in": "query",
"name": "fields",
"description": "This limits the fields which are returned, separated by comma (','). Blobs can be limited with '.' on their container. (i.e. fields=blobs.thumbnails). Only if 'thumbnails' is set, the placeholder of this asset type are returned if no thumbnail blob is found.",
"type": "string"
},
{
"in": "query",
"name": "expose",
"description": "This indicates if the given blobs should have URLs where these can be requested. (If not limited through 'fields' parameter it will expose all URLs of all blobs.)",
"type": "boolean"
},
{
"in": "query",
"name": "continuation_token",
"description": "Each result returns the continous token if more results are available than requested. With this token, the next page could be fetched. (URL encoded!)",
"type": "string"
},
{
"in": "query",
"name": "limit",
"description": "This number limits the page result of assets.",
"type": "integer",
"format": "int32"
},
{
"in": "query",
"name": "orderby",
"description": "How the return assets are sorted. Default is property: modified_date (newest first).",
"type": "string"
},
{
"in": "query",
"name": "filter",
"description": "This will limit the output on specific parameters which are separated by ':', '!:', '>', '>=', '<', '<='",
"type": "string"
},
{
"in": "query",
"name": "items",
"description": "The items can be extended to fully filled items.",
"type": "boolean"
},
{
"in": "query",
"name": "translations",
"description": "When default language should be returned and the translation dictionary is delivered. (Ignores the \"Accept-Language\" header)",
"type": "boolean"
},
{
"in": "header",
"name": "Accept-Language",
"description": "The requested language of the response. If not matching it falls back to default language.",
"type": "string"
}
],
"responses": {
"200": {
"description": "Returns the all assets (from given collection) as array.",
"schema": {
"$ref": "#/definitions/assetPageResult"
}
},
"400": {
"description": "Could not query assets. Type: {type} (Code: 2744993d-fba5-4ae3-93df-ff95035c8af7)<br>Not allowed to query assets without valid collection id. (Code: 81515ce1-8e13-4a83-84e6-fe8057d55fc5)<br>Collection id {collectionId} not found. (Code: a3fe323c-6736-43e6-a9e9-49444f3f1406)",
"schema": {
"$ref": "#/definitions/agravityErrorResponse"
}
},
"401": {
"description": "Unauthorized. API Key not provided."
},
"500": {
"description": "Internal server error. Please contact administrator."
}
},
"security": [
{
"function_key": []
}
]
}
},
"/assets/{id}": {
"get": {
"tags": [
"Public Asset Management"
],
"description": "This endpoint returns one single asset (from ID). If the returned asset is from a special asset type (e.g. \"AssetImage\") it returns the full entity.",
"operationId": "HttpAssetsGetById",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "id",
"description": "The ID of the asset.",
"required": true,
"type": "string"
},
{
"in": "query",
"name": "fields",
"description": "Which fields are need to be filled out with comma separated. If one is set all non mandatory fields are left out. No validation if field exist.",
"type": "string"
},
{
"in": "query",
"name": "expose",
"description": "This indicates if the given blobs should have URLs where these can be requested. It will expose placeholder blobs if no 'thumbnail' is found.",
"type": "boolean"
},
{
"in": "query",
"name": "translations",
"description": "When default language should be returned and the translation dictionary is delivered. (Ignores the \"Accept-Language\" header)",
"type": "boolean"
},
{
"in": "header",
"name": "Accept-Language",
"description": "The requested language of the response. If not matching it falls back to default language.",
"type": "string"
}
],
"responses": {
"200": {
"description": "Returns the the asset with the given ID include type specific fields.",
"schema": {
"$ref": "#/definitions/asset"
}
},
"404": {
"description": "If the asset with the ID was not found.",
"schema": {
"$ref": "#/definitions/agravityErrorResponse"
}
},
"401": {
"description": "Unauthorized. API Key not provided."
},
"500": {
"description": "Internal server error. Please contact administrator."
}
},
"security": [
{
"function_key": []
}
]
},
"post": {
"tags": [
"Public Asset Management"
],
"description": "This endpoint updates one single asset (from ID)",
"operationId": "HttpPublicAssetsUpdateById",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "id",
"description": "The ID of the asset.",
"required": true,
"type": "string"
},
{
"in": "query",
"name": "translations",
"description": "When default language should be returned and the translation dictionary is delivered. (Ignores the \"Accept-Language\" header)",
"type": "boolean"
},
{
"in": "header",
"name": "Accept-Language",
"description": "The requested language of the response. If not matching it falls back to default language.",
"type": "string"
},
{
"in": "body",
"name": "body",
"description": "The body has to contain one of the mentioned elements and a valid json. Not fitting properties are ignored.",
"required": true,
"schema": {
"$ref": "#/definitions/asset"
}
}
],
"responses": {
"200": {
"description": "Returns the updated full (depending on asset type) asset including custom fields.",
"schema": {
"$ref": "#/definitions/asset"
}
},
"400": {
"description": "A parameter is null. (Code: cea84d3b-ccb5-46c9-9768-11e1f81edf6c)<br>Object is not a valid asset. (Code: ea836a33-0d64-446f-8f67-2c3af564b18e)<br>Error on updating custom items. (Code: 9d044d04-53fb-4b6a-b629-554ad6ea19e2)",
"schema": {
"$ref": "#/definitions/agravityErrorResponse"
}
},
"401": {
"description": "Unauthorized. API Key not provided."
},
"404": {
"description": "If the asset with the ID was not found."
},
"500": {
"description": "Internal server error. Please contact administrator."
}
},
"security": [
{
"function_key": []
}
]
},
"delete": {
"tags": [
"Public Asset Management"
],
"operationId": "HttpAssetsDeleteById",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "id",
"description": "The ID of the asset.",
"required": true,
"type": "string"
}
],
"responses": {
"400": {
"description": "A parameter is null. (Code: 355e5695-2dcb-4495-87ff-580540ad6274)",
"schema": {
"$ref": "#/definitions/agravityErrorResponse"
}
},
"401": {
"description": "Unauthorized. API Key not provided."
},
"204": {
"description": "The delete operation of the asset with the given ID was successful."
},
"404": {
"description": "If the asset with the ID was not found."
},
"403": {
"description": "Not enough privileges to access item."
},
"500": {
"description": "Internal server error. Please contact administrator."
}
},
"security": [
{
"function_key": []
}
]
}
},
"/assetsupload": {
"post": {
"tags": [
"Public Asset Management"
],
"operationId": "HttpAssetUploadFile",
"consumes": [
"multipart/form-data"
],
"produces": [
"application/json"
],
"parameters": [
{
"in": "header",
"name": "Accept-Language",
"description": "The requested language of the response. If not matching it falls back to default language.",
"type": "string"
},
{
"name": "name",
"description": "",
"type": "string",
"in": "formData"
},
{
"name": "collectionid",
"description": "",
"type": "string",
"in": "formData"
},
{
"name": "file",
"description": "",
"type": "file",
"in": "formData"
},
{
"name": "filename",
"description": "",
"type": "string",
"in": "formData"
},
{
"name": "previewof",
"description": "",
"type": "string",
"in": "formData"
}
],
"responses": {
"201": {
"description": "Returns the created uploaded asset.",
"schema": {
"$ref": "#/definitions/asset"
}
},
"400": {
"description": "Request or Database client is null. (Code: feda1ab0-1477-4a76-abdd-3fa6fbdd0def)<br>Could not find file in multi-part data. (Code: b473c560-3ea1-4065-92e6-607973af9d9c)<br>This file is not supported. (Code: 12ac8746-349a-42c0-b73c-33257b73c728)",
"schema": {
"$ref": "#/definitions/agravityErrorResponse"
}
},
"401": {
"description": "Unauthorized. API Key not provided."
},
"500": {
"description": "Internal server error. Please contact administrator."
}
},
"security": [
{
"function_key": []
}
]
}
},
"/assetsbulkupdate": {
"post": {
"tags": [
"Public Asset Management"
],
"operationId": "HttpAssetsBulkPostUpdate",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"in": "header",
"name": "Accept-Language",
"description": "The requested language of the response. If not matching it falls back to default language.",
"type": "string"
},
{
"in": "body",
"name": "body",
"description": "This endpoint updates multiple assets. The containing keywords (tags) will be distinctly added (no removal). Only custom values are added on assets which have those items.",
"required": true,
"schema": {
"$ref": "#/definitions/assetBulkUpdate"
}
}
],
"responses": {
"200": {
"description": "Returns the info that the post update was successful. (Code: 9f12848f-573a-45bb-89ed-c44c44c1cc97)",
"schema": {
"$ref": "#/definitions/agravityInfoResponse"
}
},
"400": {
"description": "A parameter is null. (Code: 22edc392-b73c-4d89-9710-6aad5edb0c1a)<br>Object is not a valid AssetBulkUpdate object. (Code: 0112ebf9-45cd-4284-b728-2c809faa4e4b)<br>Object is empty and not a valid AssetBulkUpdate object. (Code: f81bee0b-6e4e-4b6e-8f5c-019e498ca845)<br>Not sure what to update. asset_ids is not given. (Code: 93218cdf-4511-46a7-b336-46757d788d74)<br>Not all asset_ids are valid. (Code: 07e041bd-236c-4e48-bfca-89f9f5d340af)<br>Could not find all asset_ids in database. (Code: aa4e7de0-db79-431a-b684-76d157820775)<br>Could not find all asset_ids relations in database. (Code: 100b3432-1a26-4618-ba84-b1ac72ab1ec8)<br>Error on updating custom items on asset {asset.Id}. Reason see inner exception. (Code: 72faa784-ae94-49a9-a30e-1bad3674d432<br>Error on replacing custom items on asset {asset.Id}. Reason see inner exception. (Code: e83b9194-cbfe-43ec-bbfb-6d3fae5ad4d0)<br>The mandatory item '<item.Name>' can not be removed without having default value or is of type 'userdefinedlist'. (Code: 85b9c37d-6c66-46c4-9107-f7acf198e68a)<br>Property '<item name>' is mandatory but no default value was set! (Code: 16822359-3639-4610-b075-b39aa9e106a8)<br>Property '<item name>' is not of defined type: <item type> (Code: 1e9a1470-cfba-4a56-97b0-c44f77671880)<br>Property '<item name>' is mandatory but no value was given! (Code: c23f73ed-89cb-47c1-b653-3ec99c460707)",
"schema": {
"$ref": "#/definitions/agravityErrorResponse"
}
},
"401": {
"description": "Unauthorized. API Key not provided."
},
"404": {
"description": "If the asset with the ID was not found."
},
"403": {
"description": "Not enough privileges to access item."
},
"500": {
"description": "Internal server error. Please contact administrator."
}
},
"security": [
{
"function_key": []
}
]
},
"put": {
"tags": [
"Public Asset Management"
],
"operationId": "HttpAssetsBulkPutUpdate",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"in": "header",
"name": "Accept-Language",
"description": "The requested language of the response. If not matching it falls back to default language.",
"type": "string"
},
{
"in": "body",
"name": "body",
"description": "This endpoint updates multiple assets. The containing keywords (tags) will replace existing. Only custom values are replaced on assets which have those items.",
"required": true,
"schema": {
"$ref": "#/definitions/assetBulkUpdate"
}
}
],
"responses": {
"200": {
"description": "Returns the info that the post update was successful. (Code: de2972b8-d3e3-42ff-8c2c-5bd9b088dfef)",
"schema": {
"$ref": "#/definitions/agravityInfoResponse"
}
},
"400": {
"description": "A parameter is null. (Code: 22edc392-b73c-4d89-9710-6aad5edb0c1a)<br>Object is not a valid AssetBulkUpdate object. (Code: 0112ebf9-45cd-4284-b728-2c809faa4e4b)<br>Object is empty and not a valid AssetBulkUpdate object. (Code: f81bee0b-6e4e-4b6e-8f5c-019e498ca845)<br>Not sure what to update. asset_ids is not given. (Code: 93218cdf-4511-46a7-b336-46757d788d74)<br>Not all asset_ids are valid. (Code: 07e041bd-236c-4e48-bfca-89f9f5d340af)<br>Could not find all asset_ids in database. (Code: aa4e7de0-db79-431a-b684-76d157820775)<br>Could not find all asset_ids relations in database. (Code: 100b3432-1a26-4618-ba84-b1ac72ab1ec8)<br>Error on updating custom items on asset {asset.Id}. Reason see inner exception. (Code: 72faa784-ae94-49a9-a30e-1bad3674d432<br>Error on replacing custom items on asset {asset.Id}. Reason see inner exception. (Code: e83b9194-cbfe-43ec-bbfb-6d3fae5ad4d0)<br>The mandatory item '<item.Name>' can not be removed without having default value or is of type 'userdefinedlist'. (Code: 85b9c37d-6c66-46c4-9107-f7acf198e68a)<br>Property '<item name>' is mandatory but no default value was set! (Code: 16822359-3639-4610-b075-b39aa9e106a8)<br>Property '<item name>' is not of defined type: <item type> (Code: 1e9a1470-cfba-4a56-97b0-c44f77671880)<br>Property '<item name>' is mandatory but no value was given! (Code: c23f73ed-89cb-47c1-b653-3ec99c460707)",
"schema": {
"$ref": "#/definitions/agravityErrorResponse"
}
},
"401": {
"description": "Unauthorized. API Key not provided."
},
"404": {
"description": "If the asset with the ID was not found."
},
"403": {
"description": "Not enough privileges to access item."
},
"500": {
"description": "Internal server error. Please contact administrator."
}
},
"security": [
{
"function_key": []
}
]
},
"delete": {
"tags": [
"Public Asset Management"
],
"operationId": "HttpAssetsBulkDeleteUpdate",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"in": "body",
"name": "body",
"description": "This endpoint updates multiple assets. The containing keywords (tags) will removed if existing. Only custom values are removed on assets which have those items.",
"required": true,
"schema": {
"$ref": "#/definitions/assetBulkUpdate"
}
}
],
"responses": {
"200": {
"description": "Returns the info that remove update (delete) was successful. (Code: 35e4ad14-969e-4687-83ca-51c6828b5234)",
"schema": {
"$ref": "#/definitions/agravityInfoResponse"
}
},
"400": {
"description": "A parameter is null. (Code: 22edc392-b73c-4d89-9710-6aad5edb0c1a)<br>Object is not a valid AssetBulkUpdate object. (Code: 0112ebf9-45cd-4284-b728-2c809faa4e4b)<br>Object is empty and not a valid AssetBulkUpdate object. (Code: f81bee0b-6e4e-4b6e-8f5c-019e498ca845)<br>Not sure what to update. asset_ids is not given. (Code: 93218cdf-4511-46a7-b336-46757d788d74)<br>Not all asset_ids are valid. (Code: 07e041bd-236c-4e48-bfca-89f9f5d340af)<br>Could not find all asset_ids in database. (Code: aa4e7de0-db79-431a-b684-76d157820775)<br>Could not find all asset_ids relations in database. (Code: 100b3432-1a26-4618-ba84-b1ac72ab1ec8)<br>Error on updating custom items on asset {asset.Id}. Reason see inner exception. (Code: 72faa784-ae94-49a9-a30e-1bad3674d432<br>Error on replacing custom items on asset {asset.Id}. Reason see inner exception. (Code: e83b9194-cbfe-43ec-bbfb-6d3fae5ad4d0)<br>The mandatory item '<item.Name>' can not be removed without having default value or is of type 'userdefinedlist'. (Code: 85b9c37d-6c66-46c4-9107-f7acf198e68a)<br>Property '<item name>' is mandatory but no default value was set! (Code: 16822359-3639-4610-b075-b39aa9e106a8)<br>Property '<item name>' is not of defined type: <item type> (Code: 1e9a1470-cfba-4a56-97b0-c44f77671880)<br>Property '<item name>' is mandatory but no value was given! (Code: c23f73ed-89cb-47c1-b653-3ec99c460707)",
"schema": {
"$ref": "#/definitions/agravityErrorResponse"
}
},
"401": {
"description": "Unauthorized. API Key not provided."
},
"404": {
"description": "If the asset with the ID was not found."
},
"403": {
"description": "Not enough privileges to access item."
},
"500": {
"description": "Internal server error. Please contact administrator."
}
},
"security": [
{
"function_key": []
}
]
}
},
"/assets/{id}/publish": {
"get": {
"tags": [
"Public Asset Publishing"
],
"description": "This endpoint lists all the published assets which are stored in the database if asset is still valid.",
"operationId": "HttpPublishedAssetsGet",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "id",
"description": "The ID of the asset.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Returns the all published assets as .",
"schema": {
"$ref": "#/definitions/publishEntity"
}
},
"401": {
"description": "Unauthorized. API Key not provided."
},
"500": {
"description": "Internal server error. Please contact administrator."
}
},
"security": [
{
"function_key": []
}
]
},
"post": {
"tags": [
"Public Asset Publishing"
],
"description": "This endpoint creates an additional published asset",
"operationId": "HttpPublishedAssetsCreate",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "id",
"description": "The ID of the asset.",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body",
"description": "This creates / adds an unique published asset ID and adds the information to the asset (in DB).",
"required": true,
"schema": {
"$ref": "#/definitions/publishedAsset"
}
}
],
"responses": {
"201": {
"description": "Returns the created published-asset entity.",
"schema": {
"$ref": "#/definitions/publishedAsset"
}
},
"400": {
"description": "Could not publish asset because asset or original blob could not be found. (Code: 0da83425-da4e-4586-ae31-ba51e2c84f2c)<br>Could not publish an asset which is not active. (Code: be0b47c9-cf24-4cb8-a4ab-f17cdfe6dc4e)<br>Could not publish an asset which is locked. (Code: 16dbd27d-51f8-4556-a874-6cd7ddd7a1a8)<br>Could not resize asset <assedId> for publishing. (Code: 2d9187ac-dc37-4365-a633-7ef90a326d0f)<br>Could not find optimized asset <assetId> for publishing. (Code: e59e01cb-3f39-4c36-9c71-3d28bcabe486)<br>Tried to access not existion blob: <assetId> does not exists.... (Code: a96e079b-61b3-492a-8adb-93b399287b46)<br>Publish to this target is not supported. (Code: 8136f041-60e4-40de-b534-71a7250095cc)<br>Publishing of asset <assetId> failed. Blob could not be created. (Code: 43089864-d2a4-4a42-a2c2-1a9a2048bb58)<br>Could not update asset with ID <assedId> (Code: 87429a31-01cd-4a62-9afb-81d0a56a59d2)",
"schema": {
"$ref": "#/definitions/agravityErrorResponse"
}
},
"401": {
"description": "Unauthorized. API Key not provided."
},
"500": {
"description": "Internal server error. Please contact administrator."
}
},
"security": [
{
"function_key": []
}
]
}
},
"/assets/{id}/publish/{pid}": {
"get": {
"tags": [
"Public Asset Publishing"
],
"description": "This endpoint returns one single published asset (from ID). Not checked if assetId is not deleted!",
"operationId": "HttpPublishedAssetsGetById",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "id",
"description": "The ID of the asset.",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "pid",
"description": "The published asset ID.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Returns the published asset with the given ID.",
"schema": {
"$ref": "#/definitions/publishedAsset"
}
},
"401": {
"description": "Unauthorized. API Key not provided."
},
"404": {
"description": "If the asset or published asset with the IDs were not found."
},
"500": {
"description": "Internal server error. Please contact administrator."
}
},
"security": [
{
"function_key": []
}
]
}
},
"/assets/{id}/versions": {
"post": {
"tags": [
"Public Asset Versioning"
],
"description": "This endpoint allows to create empty version or upload one asset which replaces the asset with given id and creates version.",
"operationId": "HttpAssetCreateVersion",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "id",
"description": "The ID of the asset.",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body",
"description": "This VersionedAsset to create empty version (need to upload file with metadata to blob storage)",
"required": true,
"schema": {
"$ref": "#/definitions/versionedAsset"
}
}
],
"responses": {
"201": {
"description": "Returns the created version of the asset.",
"schema": {
"$ref": "#/definitions/versionedAsset"
}
},
"400": {
"description": "Asset is not active yet. Wait until process is finished. (Code: 2e1fbeb0-b405-4985-8bac-aa604d5cd125) <br>or AgravityProcessingException occured (see message). (Code: 37eb0897-6c1b-4147-9b6d-d0e756180623)",
"schema": {
"$ref": "#/definitions/agravityErrorResponse"
}
},
"404": {
"description": "Asset could not be found in database. (Code: 9a84addc-14b7-4a29-9f33-6f8f35e16bf3)",
"schema": {
"$ref": "#/definitions/agravityErrorResponse"
}
},
"401": {
"description": "Unauthorized. API Key not provided."
},
"500": {
"description": "Internal server error. Please contact administrator."
}
},
"security": [
{
"function_key": []
}
]
},
"get": {
"tags": [
"Public Asset Versioning"
],
"description": "This endpoint lists all the versioned assets which are stored in the database if asset is still valid.",
"operationId": "HttpVersionedAssetsGet",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "id",
"description": "The ID of the asset.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Returns the VersionEntity where all versioned assets are included.",
"schema": {
"$ref": "#/definitions/versionEntity"
}
},
"401": {
"description": "Unauthorized. API Key not provided."
},
"404": {
"description": "If the version of the asset is not found."
},
"500": {
"description": "Internal server error. Please contact administrator."
}
},
"security": [
{
"function_key": []
}
]
}
},
"/assets/{id}/versionsupload": {
"post": {
"tags": [
"Public Asset Versioning"
],
"description": "This endpoint allows to upload one asset which replaces the asset with given id and creates a version which is returned.",
"operationId": "HttpAssetCreateUploadVersion",
"consumes": [
"multipart/form-data"
],
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "id",
"description": "The ID of the asset.",
"required": true,
"type": "string"
},
{
"name": "name",
"description": "",
"type": "string",
"in": "formData"
},
{
"name": "collectionid",
"description": "",
"type": "string",
"in": "formData"
},
{
"name": "file",
"description": "",
"type": "file",
"in": "formData"
},
{
"name": "filename",
"description": "",
"type": "string",
"in": "formData"
},
{
"name": "previewof",
"description": "",
"type": "string",
"in": "formData"
}
],
"responses": {
"201": {
"description": "Returns the created version of the asset.",
"schema": {
"$ref": "#/definitions/versionedAsset"
}
},
"400": {
"description": "Asset is not active yet. Wait until process is finished. (Code: 2e1fbeb0-b405-4985-8bac-aa604d5cd125) <br>or asset upload failed. Content length is insuffient (0 or too big) (Code: b9fd835c-5456-4101-a643-ed5c1d5e5335) <br>or wrong content media type. Please upload file with multipart/form-data. (Code: 553ccca6-c06f-4a1d-9b1e-ff140fbcd389) <br>or could not find file in multi-part data. (Code: 0a66cf65-8926-44f3-9e7e-89de614828ad) <br>or this file is not supported. (Code: 214ef18f-0dca-4128-8543-e20339114e11) <br>or this file has to be from same file type when asset is published! (Code: 0bcf2586-ac2a-426f-b757-2352f50b53ef) <br>or AgravityProcessingException occured (see message). (Code: 37eb0897-6c1b-4147-9b6d-d0e756180623)",
"schema": {
"$ref": "#/definitions/agravityErrorResponse"
}
},
"404": {
"description": "Asset could not be found in database. (Code: 9a84addc-14b7-4a29-9f33-6f8f35e16bf3)",
"schema": {
"$ref": "#/definitions/agravityErrorResponse"
}
},
"401": {
"description": "Unauthorized. API Key not provided."
},
"500": {
"description": "Internal server error. Please contact administrator."
}
},
"security": [
{
"function_key": []
}
]
}
},
"/assets/{id}/versions/{vNr}/restore": {
"post": {
"tags": [
"Public Asset Versioning"
],
"description": "This endpoint restores a version nr to be the current version and saves the current asset as version.",
"operationId": "HttpRestoreVersionedAssetsById",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "id",
"description": "The ID of the asset.",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "vNr",
"description": "The version number of the asset.",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body",
"description": "Only the version_info is used and will be added to the current version which is archived (before the old version is restored).",
"required": true,
"schema": {
"$ref": "#/definitions/versionedAsset"
}
}
],
"responses": {
"200": {
"description": "Returns the versioned asset.",
"schema": {
"$ref": "#/definitions/versionedAsset"
}
},
"400": {
"description": "If the version is not a number.<br>If blobs or internal, thumbs or optimized are missing. Only assets can be restored which are complete processed.",
"schema": {
"$ref": "#/definitions/agravityErrorResponse"
}
},
"401": {
"description": "Unauthorized. API Key not provided."
},
"404": {
"description": "If the asset or versioned asset with the IDs were not found."
},
"500": {
"description": "Internal server error. Please contact administrator."
}
},
"security": [
{
"function_key": []
}
]
}
},
"/assets/{id}/versions/{vNr}": {
"delete": {
"tags": [
"Public Asset Versioning"
],
"description": "This endpoint deletes a version of an asset.",
"operationId": "HttpDeleteVersionedAssetsById",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "id",
"description": "The ID of the asset.",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "vNr",
"description": "The version number of the asset.",
"required": true,
"type": "string"
}
],
"responses": {
"400": {
"description": "Given version of this asset is not a number (Code: 10fb9f76-1ee5-4b58-a642-bf37efa6c230)",
"schema": {
"$ref": "#/definitions/agravityErrorResponse"
}
},
"401": {
"description": "Unauthorized. API Key not provided."
},
"204": {
"description": "No description"
},
"404": {
"description": "If the asset or versioned asset with the IDs were not found."
},
"500": {
"description": "Internal server error. Please contact administrator."
}
},
"security": [
{
"function_key": []
}
]
},
"post": {
"tags": [
"Public Asset Versioning"
],
"description": "This endpoint updates a version of an asset.",
"operationId": "HttpUpdateVersionedAssetsById",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "id",
"description": "The ID of the asset.",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "vNr",
"description": "The version number of the asset.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "The updated asset version",
"schema": {
"$ref": "#/definitions/versionedAsset"
}
},
"400": {
"description": "Given version of this asset is not a number (Code: 10fb9f76-1ee5-4b58-a642-bf37efa6c230)",
"schema": {
"$ref": "#/definitions/agravityErrorResponse"
}
},
"401": {
"description": "Unauthorized. API Key not provided."
},
"204": {
"description": "If nothing was updated."
},
"404": {
"description": "If the asset or versioned asset with the IDs were not found."
},
"500": {
"description": "Internal server error. Please contact administrator."
}
},
"security": [
{
"function_key": []
}
]
}
},
"/assets/{id}/versions/{vNr}/blobs": {
"get": {
"tags": [
"Public Asset Versioning"
],
"description": "This endpoint checks if assets and version exists and returns the url for the requested blob.",
"operationId": "HttpGetVersionedAssetBlobById",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "id",
"description": "The ID of the asset.",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "vNr",
"description": "The version number of the asset.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"in": "query",
"name": "c",
"description": "\"t\" for thumbnail (default); \"o\" for optimized",
"type": "string"
}
],
"responses": {
"200": {
"description": "This function checks if asset exist on storage and returns the asset blob (incl. url).",
"schema": {
"$ref": "#/definitions/assetBlob"
}
},
"400": {
"description": "Given version of this asset is not a number (Code: 7a60606d-764f-4e12-9bc1-ba8512de158a)",
"schema": {
"$ref": "#/definitions/agravityErrorResponse"
}
},
"401": {
"description": "Unauthorized. API Key not provided."
},
"404": {
"description": "The requested item could not be found."
},
"500": {
"description": "Internal server error. Please contact administrator."
}
},
"security": [
{
"function_key": []
}
]
}
},
"/auth/containerwrite/{containerName}": {
"get": {
"tags": [
"Public Authentication Management"
],
"description": "This endpoint creates and returns a SAS-Token with write access for the requested container",
"operationId": "HttpAuthGetContainerWriteSasToken",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "containerName",
"description": "The name of the blob container",
"required": true,
"type": "string"
},
{
"in": "query",
"name": "code",
"description": "The API key to access this endpoint. (Alternative using header x-function-keys with same value)",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Returns SAS-Token for write access for the requested container.",
"schema": {
"$ref": "#/definitions/sasToken"
}
},
"401": {
"description": "Unauthorized. API Key not provided."
},
"400": {
"description": "A parameter is null. (Code: 0554451e-dcc9-4bef-a221-029bc3d77120)<br>Could not generate token for {containerName}. (Code: 3f19d7be-9d70-4268-93e6-de387daadd54)<br>No allowed to access containing {containerName}! (Code: fe2097fd-0370-4e30-8260-4a1d7f0e83e0)"
},
"404": {
"description": "The requested item could not be found."
},
"500": {
"description": "Internal server error. Please contact administrator."
}
},
"security": [
{
"function_key": []
}
]
}
},
"/auth/inbox": {
"get": {
"tags": [
"Public Authentication Management"
],
"description": "This endpoint creates and returns a SAS-Token with write access for the inbox container. Do not use this any longer. Use HttpAuthGetContainerWriteSasToken with inbox as container name.",
"operationId": "HttpAuthGetInboxContainerWriteSasToken",
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Returns SAS-Token for write access for the inbox.",
"schema": {
"$ref": "#/definitions/sasToken"
}
},
"401": {
"description": "Unauthorized. API Key not provided."
},
"400": {
"description": "A parameter is null. (Code: e30b767a-79e0-41f0-b3fd-dcb621fad0f1)<br>Could not generate token for inbox. (Code: 25b3843e-dbe2-4fc2-946f-3af17943c500)"
},
"404": {
"description": "The requested item could not be found."
},
"500": {
"description": "Internal server error. Please contact administrator."
}
},
"deprecated": true,
"security": [
{
"function_key": []
}
]
}
},
"/auth/users/{id}": {
"get": {
"tags": [
"Public Authentication Management"
],
"description": "This gets the user information about an Agravity User (incl. Online Status). Only full information if requester and userId are the same or it has role Admin.",
"operationId": "HttpAuthGetAgravityUserById",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "id",
"description": "The ID of the requested Agravity user.",
"required": true,
"type": "string"
},
{
"in": "query",
"name": "limit",
"description": "(Optional): If the reponse should be limited to name and email.",
"type": "boolean"
}
],
"responses": {
"200": {
"description": "Returns the Agravity user. Only if role agravity.admin or user itself get all roles, permissions, shares etc. ",
"schema": {
"$ref": "#/definitions/agravityUser"
}
},
"400": {
"description": "The given ID is not a valid Agravity user ID. (Code: 6fdb9e67-d178-4038-b9c8-552fa9ef2a74)"
},
"401": {
"description": "Unauthorized. API Key not provided."
},
"404": {
"description": "The requested item could not be found."
},
"500": {
"description": "Internal server error. Please contact administrator."
}
},
"security": [
{
"function_key": []
}
]
}
},
"/collections": {
"get": {
"tags": [
"Public Collection Management"
],
"description": "This lists all the collections which are stored in the database and not deleted (status \"A\"). This will include all specific properties from collection type.",
"operationId": "HttpCollectionsGet",
"produces": [
"application/json"
],
"parameters": [
{
"in": "query",
"name": "collectiontypeid",
"description": "The ID of the collection type where these collections should come from.",
"required": true,
"type": "string"
},
{
"in": "query",
"name": "level",
"description": "The hierarchy level of collections which should be returned.",
"type": "integer",
"format": "int32"
},
{
"in": "query",
"name": "parentid",
"description": "The ID of the parent collection which should be queried. (No collectiontypeid is required)",
"type": "string"
},
{
"in": "query",
"name": "fields",
"description": "This limits the fields which are returned, separated by comma (',').",
"type": "string"
},
{
"in": "query",
"name": "items",
"description": "The items can be extended to fully filled items.",
"type": "boolean"
},
{
"in": "query",
"name": "translations",
"description": "When default language should be returned and the translation dictionary is delivered. (Ignores the \"Accept-Language\" header)",
"type": "boolean"
},
{
"in": "header",
"name": "Accept-Language",
"description": "The requested language of the response. If not matching it falls back to default language.",
"type": "string"
}
],
"responses": {
"200": {
"description": "Returns the all collections as array.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/collection"
}
}
},
"400": {
"description": "Level not a positive number (Code: 757f7df3-3556-4c59-b5ac-9c7bfda6c3d4)",
"schema": {
"$ref": "#/definitions/agravityErrorResponse"
}
},
"401": {
"description": "Unauthorized. API Key not provided."
},
"500": {
"description": "Internal server error. Please contact administrator."
}
},
"security": [
{
"function_key": []
}
]
},
"post": {
"tags": [
"Public Collection Management"
],
"description": "This endpoint creates a unique collection ID and adds the information to the database.",
"operationId": "HttpCollectionsCreate",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"in": "query",
"name": "collectiontypeid",
"description": "The ID of the collection type where this collections should be assigned.",
"required": true,
"type": "string"
},
{
"in": "header",
"name": "Accept-Language",
"description": "The requested language of the response. If not matching it falls back to default language.",
"type": "string"
},
{
"in": "body",
"name": "body",
"description": "This endpoint creates a unique collection ID and adds the information to the database.",
"required": true,
"schema": {
"$ref": "#/definitions/collection"
}
}
],
"responses": {
"201": {
"description": "Returns the created collection.",
"schema": {
"$ref": "#/definitions/collection"
}
},
"400": {
"description": "A parameter is null. (Code: 7dac18af-04ef-4da6-8b6e-e13dd8b027ae)<br>Missing or invalid parameter \"collectiontypeid\". (Code: 42a54d68-8a33-4a71-9545-7460f7a1339d)<br>The collection type \"collectiontypeid\" was not found. (Code: 203b1950-d942-4692-8e55-0ec5c137167f)</br>Property '<item_name>' is not of defined type: <type> (Code: 1e9a1470-cfba-4a56-97b0-c44f77671880)<br>Not valid collection id. (Code: 61a99ef3-c212-4171-8b37-290d8db4af3c)<br>Collection id does not match collection type! (Code: 6da1e562-a1e2-464a-a5e2-7d2621fe21bf)<br>Can not create collection with id {input.Id}. Collection already exists. Delete first. (Code: 321c4f48-7cc9-4ece-af88-89e95031dfde)<br>Object is not a valid collection. (Code: 67dd9a9f-b899-4607-bce8-0b0c4b4eec66)",
"schema": {
"$ref": "#/definitions/agravityErrorResponse"
}
},
"401": {
"description": "Unauthorized. API Key not provided."
},
"500": {
"description": "Internal server error. Please contact administrator."
}
},
"security": [
{
"function_key": []
}
]
}
},
"/collections/{id}": {
"get": {
"tags": [
"Public Collection Management"
],
"description": "Returns one single collection (from ID). This will include all specific properties from collection type.",
"operationId": "HttpCollectionsGetById",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "id",
"description": "The ID of the collection.",
"required": true,
"type": "string"
},
{
"in": "query",
"name": "fields",
"description": "This limits the fields which are returned, separated by comma (',').",
"type": "string"
},
{
"in": "query",
"name": "items",
"description": "The items can be extended to fully filled items.",
"type": "boolean"
},
{
"in": "query",
"name": "translations",
"description": "When default language should be returned and the translation dictionary is delivered. (Ignores the \"Accept-Language\" header)",
"type": "boolean"
},
{
"in": "header",
"name": "Accept-Language",
"description": "The requested language of the response. If not matching it falls back to default language.",
"type": "string"
}
],
"responses": {
"200": {
"description": "Returns the collection with the given ID.",
"schema": {
"$ref": "#/definitions/collection"
}
},
"401": {
"description": "Unauthorized. API Key not provided."
},
"404": {
"description": "If the collection with the ID was not found."
},
"500": {
"description": "Internal server error. Please contact administrator."
}
},
"security": [
{
"function_key": []
}
]
},
"post": {
"tags": [
"Public Collection Management"
],
"description": "This endpoint updates the collection. Specific properties could be updated.",
"operationId": "HttpPublicCollectionsUpdateById",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "id",
"description": "The ID of the collection.",
"required": true,
"type": "string"
},
{
"in": "header",
"name": "Accept-Language",
"description": "The requested language of the response. If not matching it falls back to default language.",
"type": "string"
},
{
"in": "body",
"name": "body",
"description": "The body has to be a valid collection json.Not fitting properties are ignored.",
"required": true,
"schema": {
"$ref": "#/definitions/collection"
}
}
],
"responses": {
"200": {
"description": "Returns the updated collection and it includes all specific properties from collection type.",
"schema": {
"$ref": "#/definitions/collection"
}
},
"400": {
"description": "Object is not a valid collection json. Parse error. (Code: 6910ae7e-6aea-4f15-8773-1c168a66d61d)<br>Can not update. Item value of \"{item.name}\" is not of the correct type \"{item.type}\". (Code: ec1aa2cd-65be-48b9-8972-002561bbe8ef)<br>Can not update. The item \"{item.name}\" is marked as mandatory but no value was given. (Code: 2955994d-010d-4b5c-88e0-af35da5f357f)<br>Validation error parent \"{collection.parent}\" not a collection GUID. (Code: d72d01f0-1809-41fe-85ea-0e423fc8e6f6)<br>Parent \"{collection.parent}\" is not allowed because it has different collection type. (Code: 7dadb5e1-6b2f-4649-bddc-e3bed033d79b)<br>Parent \"{collection.parent}\" for collection not found (Code: 7dadb5e1-6b2f-4649-bddc-e3bed033d79b)<br>Parent \"{collection.parent}\" must not be the same as the child. (Code: fb629d4f-4b1c-41e7-a589-f5da1e6fcaff)<br>",
"schema": {
"$ref": "#/definitions/agravityErrorResponse"
}
},
"401": {
"description": "Unauthorized. API Key not provided."
},
"404": {
"description": "If the asset with the ID was not found."
},
"403": {
"description": "Not enough privileges to access item."
},
"500": {
"description": "Internal server error. Please contact administrator."
}
},
"security": [
{
"function_key": []
}
]
},
"delete": {
"tags": [
"Public Collection Management"
],
"description": "This endpoint deletes the collection with the given ID (and their siblings).",
"operationId": "HttpPublicCollectionsDeleteById",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "id",
"description": "The ID of the collection.",
"required": true,
"type": "string"
},
{
"in": "query",
"name": "deleteassets",
"description": "If this is true the assigned assets are set to delete as well.",
"type": "boolean"
}
],
"responses": {
"400": {
"description": "Collection with ID {id} is null or not a well formated collection id! (Code: 6e59a8c1-564a-411b-ad3b-3b0b78d80644)Collection with ID {id} is set as default import collection. Change the DEFAULT_IMPORT_COLLECTION_ID to another collection or DV (Default Value). (Code: c0c98df2-6f3d-481b-ae1d-89f60a86be68)<br>",
"schema": {
"$ref": "#/definitions/agravityErrorResponse"
}
},
"401": {
"description": "Unauthorized. API Key not provided."
},
"204": {
"description": "The delete operation of the collection with the given ID was successful."
},
"404": {
"description": "If the collection with the ID was not found."
},
"403": {
"description": "Not enough privileges to access item."
},
"500": {
"description": "Internal server error. Please contact administrator."
}
},
"security": [
{
"function_key": []
}
]
}
},
"/collections/{id}/ancestors": {
"get": {
"tags": [
"Public Collection Management"
],
"description": "Get the complete tree of ancestors from a single collection.",
"operationId": "HttpCollectionsGetTreeAncestorsOfId",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "id",
"description": "The ID of the collection.",
"required": true,
"type": "string"
},
{
"in": "query",
"name": "translations",
"description": "When default language should be returned and the translation dictionary is delivered. (Ignores the \"Accept-Language\" header)",
"type": "boolean"
},
{
"in": "header",
"name": "Accept-Language",
"description": "The requested language of the response. If not matching it falls back to default language.",
"type": "string"
}
],
"responses": {
"200": {
"description": "Returns the array of ancestors collections from the given collection in order by path.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/collection"
}
}
},
"400": {
"description": "Given collection id is not valid! (Code: 3f9fda3a-8911-45de-a4a0-34ea9e71e72d)",
"schema": {
"$ref": "#/definitions/agravityErrorResponse"
}
},
"404": {
"description": "If the collection with the ID was not found.",
"schema": {
"$ref": "#/definitions/agravityErrorResponse"
}
},
"401": {
"description": "Unauthorized. API Key not provided."
},
"500": {
"description": "Internal server error. Please contact administrator."
}
},
"security": [
{
"function_key": []
}
]
}
},
"/collections/{id}/descendants": {
"get": {
"tags": [
"Public Collection Management"
],
"description": "Get the complete tree of descendants from a single collection.",
"operationId": "HttpCollectionsGetDescendantsTreeOfId",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "id",
"description": "The ID of the collection.",
"required": true,
"type": "string"
},
{
"in": "query",
"name": "translations",
"description": "When default language should be returned and the translation dictionary is delivered. (Ignores the \"Accept-Language\" header)",
"type": "boolean"
},
{
"in": "header",
"name": "Accept-Language",
"description": "The requested language of the response. If not matching it falls back to default language.",
"type": "string"
}
],
"responses": {
"200": {
"description": "Returns the array of descendants collections from the given collection in order by path.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/collection"
}
}
},
"400": {
"description": "Given collection id is not valid! (Code: 1f07346f-25a5-4338-9f83-cf96cc7af67d)",
"schema": {
"$ref": "#/definitions/agravityErrorResponse"
}
},
"404": {
"description": "If the collection with the ID was not found.",
"schema": {
"$ref": "#/definitions/agravityErrorResponse"
}
},
"401": {
"description": "Unauthorized. API Key not provided."
},
"500": {
"description": "Internal server error. Please contact administrator."
}
},
"security": [
{
"function_key": []
}
]
}
},
"/collections/{id}/previews": {
"get": {
"tags": [
"Public Collection Management"
],
"description": "This endpoint returns a generated thumbnail as a preview of the containing assets.",
"operationId": "HttpGetCollectionPreviewsById",
"produces": [
"image/png",
"application/json"
],
"parameters": [
{
"in": "path",
"name": "id",
"description": "The ID of the collection.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Returns a generated png image as byte array.",
"schema": {
"type": "string"
}
},
"404": {
"description": "If the collection with the ID was not found.",
"schema": {
"$ref": "#/definitions/agravityErrorResponse"
}
},
"401": {
"description": "Unauthorized. API Key not provided."
},
"500": {
"description": "Internal server error. Please contact administrator."
}
},
"security": [
{
"function_key": []
}
]
}
},
"/collectionsbynames": {
"post": {
"tags": [
"Public Collection Management"
],
"description": "This endpoint fetches all collections based on names which comes from an array inside the POST request body and return another list of EntityIdName objects and an array of strings with the names which could not be found.",
"operationId": "HttpPublicPostCollectionsGetByNames",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"in": "body",
"name": "body",
"description": "An object with the array of strings with names of the collections to fetch.",
"required": true,
"schema": {
"$ref": "#/definitions/entityNamesRequest"
}
}
],
"responses": {
"200": {
"description": "Returns an array of EntityIdName objects with the found collections and an array of strings with the names which could not be found.",
"schema": {
"$ref": "#/definitions/entityListResult"
}
},
"401": {
"description": "Unauthorized. API Key not provided."
},
"400": {
"description": "The request body is not a valid array of strings."
},
"500": {
"description": "Internal server error. Please contact administrator."
}
},
"security": [
{
"function_key": []
}
]
}
},
"/secureupload/{id}": {
"get": {
"tags": [
"Public Collection Secure Upload"
],
"description": "Searchs for one single secure upload entity of an user and returns simple OK if found.",
"operationId": "HttpSecureUploadEntityCheckById",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "id",
"description": "The ID of the secure upload collection.",
"required": true,
"type": "string"
},
{
"in": "query",
"name": "code",
"description": "The API key to access this endpoint. (Alternative using header x-function-keys with same value)",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Returns 200 (OK) and returns the element - if this still exists, is valid and API Key is accepted.",
"schema": {
"$ref": "#/definitions/secureUploadEntity"
}
},
"400": {
"description": "Not a valid secure upload id! (Code: f233ecb7-9f4e-43df-a6b6-172aa9ee66d0)<br>or No API key was provided. Please use 'code' param or 'x-functions-key' header property. (Code: a8843706-c481-4859-9555-2423dbdcc1a2)<br>or No matching API key or wrong password for this secure upload entity. (Code: e39a5c12-bbeb-4056-b717-2af89e21b319)<br>or Provided API key seems to be valid for authorization, but not to access this secure upload. (Code: ec38934a-43be-48ba-bf6f-b2e3b505812c)<br>or Secure upload entity date expired! (Code: c7ec0d4d-95e5-4211-b89e-c88a05d89571)}<br>or Provided API key seems to be valid for authentication, the ID does not match. (Code: d8e07922-173d-420c-a75c-539a5a182ad1)",
"schema": {
"$ref": "#/definitions/agravityErrorResponse"
}
},
"404": {
"description": "Secure upload entity not found for this user. (Code: 27ccd9e4-f5aa-4826-8384-b59451987bb9)<br>or Secure upload entity not found. (Code: 639ec439-2ec0-4c4e-9d5b-688be06e2234)<br>or Collection on which this secure upload is based, doesn't exist or is invalid! (Code: 3adffb93-800d-46a2-9bde-341216fc5f01)",
"schema": {
"$ref": "#/definitions/agravityErrorResponse"
}
},
"401": {
"description": "Unauthorized. API Key not provided."
},
"500": {
"description": "Internal server error. Please contact administrator."
}
},
"security": [
{
"function_key": []
}
]
}
},
"/secureupload/{id}/upload": {
"post": {
"tags": [
"Public Collection Secure Upload"
],
"description": "This endpoint allows to securly upload one asset which is put onto the storage (INBOX). Object has to be FormData (Add file).",
"operationId": "HttpSecureUploadFileById",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "id",
"description": "The ID of the secure upload collection.",
"required": true,
"type": "string"
},
{
"in": "query",
"name": "code",
"description": "The API key to access this endpoint. (Alternative using header x-function-keys with same value)",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body",
"description": "This endpoint allows to upload one asset which is put onto the storage (INBOX). Object has to be FormData (Add file).",
"required": true,
"schema": {
"$ref": "#/definitions/file"
}
}
],
"responses": {
"201": {
"description": "Returns the asset which was created.",
"schema": {
"$ref": "#/definitions/asset"
}
},
"400": {
"description": "Secure upload failed. Content length is insuffient (0 or bigger than defined limit - default and maximum: 100 MB) (Code: bf2bdfc4-de75-42e4-add7-6cf7a546a3c0)<br>or Not a valid secure upload id! (Code: f233ecb7-9f4e-43df-a6b6-172aa9ee66d0)<br>or No API key was provided. Please use 'code' param or 'x-functions-key' header property. (Code: a8843706-c481-4859-9555-2423dbdcc1a2)<br>or No matching API key or wrong password for this secure upload entity. (Code: e39a5c12-bbeb-4056-b717-2af89e21b319)<br>or Provided API key seems to be valid for authorization, but not to access this secure upload. (Code: ec38934a-43be-48ba-bf6f-b2e3b505812c)<br>or Secure upload entity date expired! (Code: c7ec0d4d-95e5-4211-b89e-c88a05d89571)<br>or Provided API key seems to be valid for authentication, the ID does not match. (Code: d8e07922-173d-420c-a75c-539a5a182ad1)<br>or Wrong content media type. Please upload file with multipart/form-data. (Code: 4cdc8bde-e79f-4f52-a4cc-7b7c4d967b3c)<br>or Could not find file in multi-part data. (Code: 00440233-ef4a-48a1-ad7d-824232d7a17f)<br>or This file is not supported. (Code: 4b086d7e-dda3-4530-9d23-41a32a91b0fe)",
"schema": {
"$ref": "#/definitions/agravityErrorResponse"
}
},
"404": {
"description": "Secure upload entity not found for this user. (Code: 27ccd9e4-f5aa-4826-8384-b59451987bb9)<br>or Secure upload entity not found. (Code: 639ec439-2ec0-4c4e-9d5b-688be06e2234)<br>or Collection on which this secure upload is based, doesn't exist or is invalid! (Code: 3adffb93-800d-46a2-9bde-341216fc5f01)<br>or If the collection where this secure upload points to is not found.",
"schema": {
"$ref": "#/definitions/agravityErrorResponse"
}
},
"401": {
"description": "Unauthorized. API Key not provided."
},
"500": {
"description": "Internal server error. Please contact administrator."
}
},
"security": [
{
"function_key": []
}
]
}
},
"/collectiontypes": {
"get": {
"tags": [
"Public Collection Type Management"
],
"description": "This lists all available collection types which are stored in the database and not deleted (status \"A\").",
"operationId": "HttpCollectionTypesGet",
"produces": [
"application/json"
],
"parameters": [
{
"in": "query",
"name": "translations",
"description": "When default language should be returned and the translation dictionary is delivered. (Ignores the \"Accept-Language\" header)",
"type": "boolean"
},
{
"in": "header",
"name": "Accept-Language",
"description": "The requested language of the response. If not matching it falls back to default language.",
"type": "string"
}
],
"responses": {
"200": {
"description": "Returns the all collection types as array.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/collectionType"
}
}
},
"400": {
"description": "Could not create connection to CosmosDB (Code: e244cef3-2665-4757-ba34-0d4d0e71bb9d)",
"schema": {
"$ref": "#/definitions/agravityErrorResponse"
}
},
"401": {
"description": "Unauthorized. API Key not provided."
},
"500": {
"description": "Internal server error. Please contact administrator."
}
},
"security": [
{
"function_key": []
}
]
}
},
"/collectiontypes/{id}": {
"get": {
"tags": [
"Public Collection Type Management"
],
"description": "Returns one single collection type (from ID).",
"operationId": "HttpCollectionTypesGetById",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "id",
"description": "The ID of the collection type.",
"required": true,
"type": "string"
},
{
"in": "query",
"name": "translations",
"description": "When default language should be returned and the translation dictionary is delivered. (Ignores the \"Accept-Language\" header)",
"type": "boolean"
},
{
"in": "header",
"name": "Accept-Language",
"description": "The requested language of the response. If not matching it falls back to default language.",
"type": "string"
}
],
"responses": {
"200": {
"description": "Returns the collection type with the given ID.",
"schema": {
"$ref": "#/definitions/collectionType"
}
},
"404": {
"description": "If the collection type with the ID was not found.",
"schema": {
"$ref": "#/definitions/agravityErrorResponse"
}
},
"401": {
"description": "Unauthorized. API Key not provided."
},
"500": {
"description": "Internal server error. Please contact administrator."
}
},
"security": [
{
"function_key": []
}
]
}
},
"/collectiontypesitems": {
"get": {
"tags": [
"Public Collection Type Management"
],
"description": "This method returns a list of collection types items. (Regardless of the permissions)",
"operationId": "HttpGetCollectionTypeItems",
"produces": [
"application/json"
],
"parameters": [
{
"in": "query",
"name": "includeblueprint",
"description": "True if the blueprint items should be included.",
"type": "boolean"
},
{
"in": "query",
"name": "translations",
"description": "When default language should be returned and the translation dictionary is delivered. (Ignores the \"Accept-Language\" header)",
"type": "boolean"
},
{
"in": "header",
"name": "Accept-Language",
"description": "The requested language of the response. If not matching it falls back to default language.",
"type": "string"
}
],
"responses": {
"200": {
"description": "The collection types items for this item.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/collTypeItem"
}
}
},
"401": {
"description": "Unauthorized. API Key not provided."
},
"404": {
"description": "If the no collection type items were not found."
}
},
"security": [
{
"function_key": []
}
]
}
},
"/config/frontend": {
"get": {
"tags": [
"Public Configuration Management"
],
"description": "Lists config value only for frontend stored in config table. Optional to filter for custom values only.",
"operationId": "HttpConfigGetFrontendAll",
"produces": [
"application/json"
],
"parameters": [
{
"in": "query",
"name": "customonly",
"description": "This returns only the custom created configurations.",
"type": "boolean"
}
],
"responses": {
"200": {
"description": "Returns the frontend configations values in store",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/frontendAppConfig"
}
}
},
"404": {
"description": "No config table could be found. (Code: 33d6286a-b7a4-428e-9f0b-cf7488d174ac)",
"schema": {
"$ref": "#/definitions/agravityErrorResponse"
}
},
"401": {
"description": "The config table could be be accessed. (Code: b9f176b8-cf22-4815-a90c-5a40611d2cfa)",
"schema": {
"$ref": "#/definitions/agravityErrorResponse"
}
},
"500": {
"description": "Internal server error. Please contact administrator."
}
}
}
},
"/downloadformats": {
"get": {
"tags": [
"Public Download Format Management"
],
"description": "This endpoint lists all download formats in database.",
"operationId": "HttpDownloadFormatsGetAll",
"produces": [
"application/json"
],
"parameters": [
{
"in": "header",
"name": "Accept-Language",
"description": "The requested language of the response. If not matching it falls back to default language.",
"type": "string"
}
],
"responses": {
"200": {
"description": "Returns all download formats in database.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/downloadFormat"
}
}
},
"401": {
"description": "Unauthorized. API Key not provided."
},
"500": {
"description": "Internal server error. Please contact administrator."
}
},
"security": [
{
"function_key": []
}
]
}
},
"/downloadformats-shared": {
"get": {
"tags": [
"Public Download Format Management"
],
"description": "This endpoint lists all download formats for a specific shared collections in database.Needs a valid shared collection ID to be authenticated.",
"operationId": "HttpDownloadFormatsGetAllFromShared",
"produces": [
"application/json"
],
"parameters": [
{
"in": "query",
"name": "share_id",
"description": "This share ID is like an API key. Check on validy (format, expire, collection still availabe). Otherwise StatusCode 403 (Forbidden) is returned.",
"required": true,
"type": "string"
},
{
"in": "header",
"name": "ay-password",
"description": "If shared collection has a password, this header is mandatory. Otherwise StatusCode 403 (Forbidden) is returned.",
"type": "string"
},
{
"in": "header",
"name": "Accept-Language",
"description": "The requested language of the response. If not matching it falls back to default language.",
"type": "string"
}
],
"responses": {
"200": {
"description": "Returns download formats for the shared collection in database.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/downloadFormat"
}
}
},
"403": {
"description": "Not enough privileges to access item."
},
"500": {
"description": "Internal server error. Please contact administrator."
}
}
}
},
"/public/view": {
"get": {
"tags": [
"Public Endpoints"
],
"description": "This endpoint returns the content of an asset which is available in a specific portal (portal_id is \"key\") and returns the blob directly.",
"operationId": "HttpAssetGetViewForPortal",
"produces": [
"application/octet-stream",
"application/json"
],
"parameters": [
{
"in": "query",
"name": "asset_id",
"description": "The ID of the asset.",
"required": true,
"type": "string"
},
{
"in": "query",
"name": "portal_id",
"description": "If the request comes from portal this is the indicator.",
"required": true,
"type": "string"
},
{
"in": "query",
"name": "format",
"description": "The name of the format (download format) or container.",
"required": true,
"type": "string"
},
{
"in": "query",
"name": "download",
"description": "True if a direct download with file name should be started.",
"type": "string"
}
],
"responses": {
"200": {
"description": "Returns the direct blob for download.",
"schema": {
"format": "binary",
"type": "string"
}
},
"400": {
"description": "Portal ID is mandatory and not valid. {type} (Code: be59e94a-0f76-415f-a6b7-065e3abfc64e)<br>Downloadformat is not allowed on other asset type than image (Code: e77d141b-a2b4-4746-8910-5b97b2623cc4)<br>Downloadformat with id '{format}' not found. (Code: eb70a990-6a28-40b1-8631-63a085fd8ac3)<br>Tried to access not existion blob: {asset.Id} from container: {downloadFormat.OriginContainer}. (Code: 53683b61-67f4-47f9-9392-e7c651175854)<br>General error with message. (Code: 5cd6a8bd-2a53-4b6a-adef-efd898e8c248)<br>Blob with format '{format}' not found. (Code: 5a656869-4678-41dd-a311-af79e319d83f)<br>Get view from asset {asset?.Id} failed. Format '{format}' not found. (Code: 34473124-d3d4-4de0-8112-6798e4728e1f)",
"schema": {
"$ref": "#/definitions/agravityErrorResponse"
}
},
"404": {
"description": "The requested item could not be found."
},
"500": {
"description": "Internal server error. Please contact administrator."
}
}
}
},
"/version": {
"get": {
"tags": [
"Public General Management"
],
"description": "Get the current version of the backend. To see if backend was updated or not.",
"operationId": "HttpAgravityVersionInfo",
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "All information about backend.",
"schema": {
"$ref": "#/definitions/agravityVersion"
}
},
"400": {
"description": "Only if any of the input variable are null (Code: 9a6fb6f2-4b7b-4253-a4f3-5a46b7ba0ca8)",
"schema": {
"$ref": "#/definitions/agravityErrorResponse"
}
},
"404": {
"description": "Only if assembly could not found (?)"
}
}
}
},
"/deleted": {
"get": {
"tags": [
"Public General Management"
],
"description": "This endpoint checks all deleted entities in the database until a specific date and returns the elements which are deleted.",
"operationId": "HttpGetDeletedEntities",
"produces": [
"application/json"
],
"parameters": [
{
"in": "query",
"name": "entity_type",
"description": "The type of the entity (e.g. 'asset', 'collection_type', 'collection_type'",
"type": "string"
},
{
"in": "query",
"name": "since",
"description": "The date in the past since the entities are marked as deleted in the database.",
"type": "string"
},
{
"in": "query",
"name": "until",
"description": "The date in the past until the entities are marked as deleted in the database.",
"type": "string"
},
{
"in": "query",
"name": "portal_id",
"description": "If the request comes from portal this is the indicator.",
"type": "string"
}
],
"responses": {
"200": {
"description": "A list of entities which are deleted since the given date (last modified date = deleted date).",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/deletedEntities"
}
}
},
"400": {
"description": "Since date could not be more in the future than until date. (Code: d362e2d4-b6b1-4547-a97c-058d2f46acfc)<br>Entity type '{entityType}' is not valid. (Code: 79abc89e-e072-4cf5-a63a-1573764975c6)<br>Entity type '{entityType}' is not allowed for this user. (Code: b00efbb5-faeb-4758-9ea3-44b5435a2311)<br>Error on getting deleted entities. (Code: 71fad553-4c82-423a-807e-ba272bfd3404)<br>",
"schema": {
"$ref": "#/definitions/agravityErrorResponse"
}
},
"401": {
"description": "Unauthorized. API Key not provided."
},
"404": {
"description": "When the portal_id could not be found."
},
"500": {
"description": "Internal server error. Please contact administrator."
}
},
"security": [
{
"function_key": []
}
]
}
},
"/durable/{instanceId}": {
"get": {
"tags": [
"Public General Management"
],
"description": "Trigger the durable execution to continue",
"operationId": "HttpTriggerDurableContinue",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "instanceId",
"description": "The instance ID of the durable function.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Operation successfull",
"schema": {
"$ref": "#/definitions/agravityInfoResponse"
}
},
"400": {
"description": "Only if instaceId is null",
"schema": {
"$ref": "#/definitions/agravityErrorResponse"
}
}
}
}
},
"/durable/scch/{instanceId}": {
"get": {
"tags": [
"Public General Management"
],
"description": "Trigger the durable execution to continue",
"operationId": "HttpTriggerDurableScchTrainingDone",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "instanceId",
"description": "The instance ID of the durable function.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Operation successfull",
"schema": {
"$ref": "#/definitions/agravityInfoResponse"
}
},
"400": {
"description": "Only if instaceId is null",
"schema": {
"$ref": "#/definitions/agravityErrorResponse"
}
}
}
}
},
"/helper/userdefinedlists": {
"get": {
"tags": [
"Public Helper Tools"
],
"description": "Returns all user defined lists of all collection types",
"operationId": "HttpGetAllUserDefinedLists",
"produces": [
"application/json"
],
"parameters": [
{
"in": "query",
"name": "translations",
"description": "When default language should be returned and the translation dictionary is delivered. (Ignores the \"Accept-Language\" header)",
"type": "boolean"
},
{
"in": "header",
"name": "Accept-Language",
"description": "The requested language of the response. If not matching it falls back to default language.",
"type": "string"
}
],
"responses": {
"200": {
"description": "A list of all user defined list entries.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/collectionUDL"
}
}
},
"401": {
"description": "Unauthorized. API Key not provided."
},
"500": {
"description": "Internal server error. Please contact administrator."
}
},
"security": [
{
"function_key": []
}
]
},
"patch": {
"tags": [
"Public Helper Tools"
],
"description": "This updates the cached user defined lists and store it in the system.",
"operationId": "HttpPatchUpdateCachedUserDefinedLists",
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "A full list of all UDLs and the collection types they are in and their permissions.",
"schema": {
"$ref": "#/definitions/collectionUDLListEntity"
}
},
"401": {
"description": "Unauthorized. API Key not provided."
},
"403": {
"description": "Not enough privileges to access item."
}
},
"security": [
{
"function_key": []
}
]
}
},
"/helper/searchableitemnames": {
"get": {
"tags": [
"Public Helper Tools"
],
"description": "Returns all searchable items directly from the search index",
"operationId": "HttpGetAllowedSearchableItemNames",
"produces": [
"application/json"
],
"parameters": [
{
"in": "query",
"name": "portal_id",
"description": "If the search should be redirected to a specific portal.",
"type": "string"
}
],
"responses": {
"400": {
"description": "Argument is null. (Code: 7e0e127f-d12d-441d-8405-25d91f2b32d6)<br>Argument exception: {message} (Code: 35c2fd8d-30ca-4c72-80fd-de91973b9c99)<br>Request failed: {message} (Code: fb5e9c1b-1206-4488-9240-3cc949c23646)<br>General error: {message} ({typeOfException}) (Code: e0289b2f-7a44-4cc6-a552-f025e5cdad3e)",
"schema": {
"$ref": "#/definitions/agravityErrorResponse"
}
},
"200": {
"description": "A string list of all searchable items.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"401": {
"description": "Unauthorized. API Key not provided."
}
},
"security": [
{
"function_key": []
}
]
}
},
"/helper/searchableitems": {
"get": {
"tags": [
"Public Helper Tools"
],
"description": "Returns all searchable items directly from the search index",
"operationId": "HttpGetAllowedSearchableItems",
"produces": [
"application/json"
],
"parameters": [
{
"in": "query",
"name": "portal_id",
"description": "If the search should be redirected to a specific portal.",
"type": "string"
}
],
"responses": {
"200": {
"description": "A list of all searchable items.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/searchableItem"
}
}
},
"400": {
"description": "Argument is null. (Code: 5e87014c-7ac4-4487-b91d-ce03438d5d45)<br>Argument exception: {message} (Code: 1f7fb1e7-dbf4-41a8-b89c-9829067a1ca6)<br>Request failed: {message} (Code: b66c90a6-482e-40ee-b77d-06e001803ae0)<br>General error: {message} ({typeOfException}) (Code: 4ff25dc7-47dd-4bec-bcce-6ecdb11b01c8)",
"schema": {
"$ref": "#/definitions/agravityErrorResponse"
}
},
"401": {
"description": "Unauthorized. API Key not provided."
}
},
"security": [
{
"function_key": []
}
]
}
},
"/helper/filterableitems": {
"get": {
"tags": [
"Public Helper Tools"
],
"description": "Returns all filterable items directly from the search index",
"operationId": "HttpGetAllowedFilterableItems",
"produces": [
"application/json"
],
"parameters": [
{
"in": "query",
"name": "portal_id",
"description": "If the search should be redirected to a specific portal.",
"type": "string"
}
],
"responses": {
"200": {
"description": "A string list of all filterable items.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"400": {
"description": "Argument is null. (Code: e12181d0-371e-47c4-88cc-1d2453a7d9a6)<br>Argument exception: {message} (Code: e109ada5-d770-43f3-a6e0-7d869b0bb8e1)<br>Request failed: {message} (Code: 2da00496-7e74-4c11-8bd0-1e92cbc8875a)<br>General error: {message} ({typeOfException}) (Code: 8c14ca12-da21-4a87-9bcd-9958407f102d)",
"schema": {
"$ref": "#/definitions/agravityErrorResponse"
}
},
"401": {
"description": "Unauthorized. API Key not provided."
}
},
"security": [
{
"function_key": []
}
]
}
},
"/publish": {
"get": {
"tags": [
"Public Publishing"
],
"description": "This endpoint lists all the published assets which are stored in the database",
"operationId": "HttpPublishedAssetsGetAll",
"produces": [
"application/json"
],
"parameters": [
{
"in": "query",
"name": "cid",
"description": "Filter response for collection",
"type": "string"
},
{
"in": "query",
"name": "incldescendants",
"description": "Include collections further down in hierarchy",
"type": "boolean"
}
],
"responses": {
"200": {
"description": "Returns the all published assets as .",
"schema": {
"$ref": "#/definitions/publishEntity"
}
},
"401": {
"description": "Unauthorized. API Key not provided."
},
"500": {
"description": "Internal server error. Please contact administrator."
}
},
"security": [
{
"function_key": []
}
]
}
},
"/savedsearches": {
"get": {
"tags": [
"Public Saved Search"
],
"description": "This endpoint lists all saved searches in database.",
"operationId": "HttpSavedSearchesGetAll",
"produces": [
"application/json"
],
"parameters": [
{
"in": "query",
"name": "external",
"description": "This parameter filters out all saved searches on basis this boolean. Only admins can request the external saved searches.",
"type": "boolean"
},
{
"in": "query",
"name": "translations",
"description": "When default language should be returned and the translation dictionary is delivered. (Ignores the \"Accept-Language\" header)",
"type": "boolean"
},
{
"in": "header",
"name": "Accept-Language",
"description": "The requested language of the response. If not matching it falls back to default language.",
"type": "string"
}
],
"responses": {
"200": {
"description": "Returns all saved searches in database.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/savedSearch"
}
}
},
"401": {
"description": "Unauthorized. API Key not provided."
},
"500": {
"description": "Internal server error. Please contact administrator."
}
},
"security": [
{
"function_key": []
}
]
}
},
"/search": {
"get": {
"tags": [
"Public Search Management"
],
"description": "This endpoint returns a configured max amount of results for search terms.",
"operationId": "HttpGlobalSearch",
"produces": [
"application/json"
],
"parameters": [
{
"in": "query",
"name": "s",
"description": "The search string which should be found.",
"required": true,
"type": "string"
},
{
"in": "query",
"name": "limit",
"description": "How many results should be returend. 0 is backend configuration limit.",
"type": "integer",
"format": "int32"
},
{
"in": "query",
"name": "skip",
"description": "(default: 0) - Used for paging - how many items should be skipped before next limit results will be fetched.",
"type": "integer",
"format": "int32"
},
{
"in": "query",
"name": "collectiontypeid",
"description": "Limits the result on all collections from the given collectiontypeid parameter.",
"type": "string"
},
{
"in": "query",
"name": "collectionid",
"description": "Limits the result on collection id (and siblings). Will be overwritten by collectiontypeid parameter.",
"type": "string"
},
{
"in": "query",
"name": "mode",
"description": "Two modes supported: \"any\" or \"all\" search terms should be applied. (Only if Azure Search is enabled)",
"type": "string"
},
{
"in": "query",
"name": "expose",
"description": "This will expose the thumbnail asset blob incl. URL with SAS Token.",
"type": "boolean"
},
{
"in": "query",
"name": "filter",
"description": "Colon separated key value filter for filterable strings and string collections. For date or numbers \"<\", \"=\" and \">\" are possible. Mode influences AND (all) and OR (any) of all filters. Multiple filters are separated by semicolons. (Only if Azure Search is enabled)",
"type": "string"
},
{
"in": "query",
"name": "broadness",
"description": "Search Broadness: Can be 0, 1 or 2. (0 is the most exact search, 2 is the broadest search) (1, 2 is with AI)",
"type": "integer",
"format": "int32"
},
{
"in": "query",
"name": "rel_id",
"description": "The ID of the relation which this search is limited to. (Only the assets in this relation are returend)",
"type": "string"
},
{
"in": "query",
"name": "scopefilter",
"description": "Colon separated key value filter for additional scopes. It applies the same conventions as for filter parameter.",
"type": "string"
},
{
"in": "query",
"name": "orderby",
"description": "Sortable fields can be used. For descendant sorting use leading \"!\". (Only if Azure Search is enabled)",
"type": "string"
},
{
"in": "query",
"name": "ids",
"description": "Comma separated values list with all ids which should be returned.",
"type": "string"
},
{
"in": "query",
"name": "portal_id",
"description": "If the search should be redirected to a specific portal.",
"type": "string"
},
{
"in": "query",
"name": "translations",
"description": "When default language should be returned and the translation dictionary is delivered. (Ignores the \"Accept-Language\" header)",
"type": "boolean"
},
{
"in": "header",
"name": "Accept-Language",
"description": "The requested language of the response. If not matching it falls back to default language.",
"type": "string"
}
],
"responses": {
"200": {
"description": "Returns the search result",
"schema": {
"$ref": "#/definitions/searchResult"
}
},
"400": {
"description": "A required parameter is null. (Code: 870f62fe-827a-4ef3-98e7-7f309244ee00)<br>or provide at least parameter \"s=\" with search string (url encoded) (Code: de39bfb1-42e3-4edf-9651-5c4952524e69)<br>or limit is not a valid number! Can use 0 for defined limit. (Code: 7115dc96-99e3-47a4-827a-8cc63cc1ab68\nor skip is not a valid number! Can use 0 for defined skip. (Code: ad8237e0-236c-4404-8eaa-d81a9fa4e41c\nor parameter \"collectiontypeid=\" is not valid (not in correct format or not found in system). (Code: 330e6abb-e77e-4193-9aa0-9dfce168c674)<br>or parameter \"collectionid=\" is not valid (not in correct format or not found in system). (Code: c20f1dfb-0d19-419e-96eb-f5dee44576fe)",
"schema": {
"$ref": "#/definitions/agravityErrorResponse"
}
},
"401": {
"description": "Unauthorized. API Key not provided."
},
"500": {
"description": "Internal server error. Please contact administrator."
}
},
"security": [
{
"function_key": []
}
]
}
},
"/search/facette": {
"get": {
"tags": [
"Public Search Management"
],
"description": "This endpoint returns one facette based on the search parameters.",
"operationId": "HttpGetSearchFacetteByName",
"produces": [
"application/json"
],
"parameters": [
{
"in": "query",
"name": "name",
"description": "The name of the facette.",
"required": true,
"type": "string"
},
{
"in": "query",
"name": "s",
"description": "The search string which should be found.",
"required": true,
"type": "string"
},
{
"in": "query",
"name": "collectiontypeid",
"description": "Limits the result on all collections from the given collectiontypeid parameter.",
"type": "string"
},
{
"in": "query",
"name": "collectionid",
"description": "Limits the result on collection id (and siblings). Will be overwritten by collectiontypeid parameter.",
"type": "string"
},
{
"in": "query",
"name": "mode",
"description": "Two modes supported: \"any\" or \"all\" search terms should be applied. (Only if Azure Search is enabled)",
"type": "string"
},
{
"in": "query",
"name": "filter",
"description": "Key value filter for filterable strings and string collections separated by special ',,,'. For date or numbers \"<\", \"=\" and \">\" are possible. Mode influences AND (all) and OR (any) of all filters. Multiple filters are separated by semicolons. (Only if Azure Search is enabled)",
"type": "string"
},
{
"in": "query",
"name": "scopefilter",
"description": "Colon separated key value filter for additional scopes. It applies the same conventions as for filter parameter.",
"type": "string"
},
{
"in": "query",
"name": "ids",
"description": "Comma separated values list with all ids which should be returned.",
"type": "string"
},
{
"in": "query",
"name": "portal_id",
"description": "If the search should be redirected to a specific portal.",
"type": "string"
}
],
"responses": {
"200": {
"description": "Returns the search result",
"schema": {
"$ref": "#/definitions/searchFacet"
}
},
"400": {
"description": "A required parameter is null. (Code: 870f62fe-827a-4ef3-98e7-7f309244ee00)<br>or provide at least parameter \"s=\" with search string (url encoded) (Code: 180db53c-9789-4588-ac4b-23d0c1eb1c06)<br>or limit is not a valid number! Can use 0 for defined limit. (Code: 7115dc96-99e3-47a4-827a-8cc63cc1ab68<br>or skip is not a valid number! Can use 0 for defined skip. (Code: ad8237e0-236c-4404-8eaa-d81a9fa4e41c<br>Parameter \"portal_id=\" is not valid.(Code: 2ef46a2f-07a5-4ee3-acef-5b421c3f493a)<br>Parameter \"portal_id=\" is not found in system. (Code: d0ed0426-9c08-4490-b43c-660093f63db9)<br>Azure Search is not enabled! (Code: ddeb49b9-9574-4682-a7bd-b2946033983f)<br>or parameter \"collectiontypeid=\" is not valid (not in correct format or not found in system). (Code: 330e6abb-e77e-4193-9aa0-9dfce168c674)<br>or parameter \"collectionid=\" is not valid (not in correct format or not found in system). (Code: c20f1dfb-0d19-419e-96eb-f5dee44576fe)",
"schema": {
"$ref": "#/definitions/agravityErrorResponse"
}
},
"401": {
"description": "Unauthorized. API Key not provided."
},
"500": {
"description": "Internal server error. Please contact administrator."
}
},
"security": [
{
"function_key": []
}
]
}
},
"/searchadmin/status": {
"get": {
"tags": [
"Public Search Management"
],
"description": "This endpoint gives the status about the index and indexer.",
"operationId": "HttpSearchAdminGetStatus",
"produces": [
"application/json"
],
"parameters": [
{
"in": "query",
"name": "portal_id",
"description": "If the search should be redirected to a specific portal.",
"type": "string"
}
],
"responses": {
"200": {
"description": "This gives status about the search.",
"schema": {
"$ref": "#/definitions/searchAdminStatus"
}
},
"401": {
"description": "Unauthorized. API Key not provided."
},
"500": {
"description": "Internal server error. Please contact administrator."
}
},
"security": [
{
"function_key": []
}
]
}
},
"/shared/{id}": {
"get": {
"tags": [
"Public Sharing Management"
],
"description": "Returns one single shared collection (from ID)",
"operationId": "HttpSharedCollectionsGetById",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "id",
"description": "The ID of the shared collection.",
"required": true,
"type": "string"
},
{
"in": "header",
"name": "ay-password",
"description": "If shared collection has a password, this header is mandatory. Otherwise StatusCode 403 (Forbidden) is returned.",
"type": "string"
},
{
"in": "query",
"name": "continuation_token",
"description": "Each result returns the continous token if more results are available than requested. With this token, the next page could be fetched. (URL encoded!)",
"type": "string"
},
{
"in": "query",
"name": "limit",
"description": "This number limits the page result of assets.",
"type": "integer",
"format": "int32"
},
{
"in": "query",
"name": "orderby",
"description": "How the return assets are sorted. Default is property: created_date (newest first).",
"type": "string"
},
{
"in": "header",
"name": "Accept-Language",
"description": "The requested language of the response. If not matching it falls back to default language.",
"type": "string"
}
],
"responses": {
"200": {
"description": "Returns the shared collection with the given ID.",
"schema": {
"$ref": "#/definitions/sharedCollectionFull"
}
},
"400": {
"description": "A parameter is null (Code: e61dfb16-e486-4c15-8b55-276bd85d291e)<br>or not valid shared id! (Code: e1eb7b29-e501-4727-bec3-26f5099b7418)",
"schema": {
"$ref": "#/definitions/agravityErrorResponse"
}
},
"404": {
"description": "Collection on which this share is based, doesn't exist. (Code: 79dde226-ae08-4f4b-b334-de0cad89c994)<br>or Shared collection date expired! (Code: 6758d66e-0ce6-4770-a497-01a578eac12c)<br>or Shared collection not found. (Code: 87d09a21-14d6-4da4-ab69-01e6c87f108c)<br>or User null or shared collection of user not found. (Code: 5a1ea520-377d-43f1-b2c3-506443056561)<br>",
"schema": {
"$ref": "#/definitions/agravityErrorResponse"
}
},
"401": {
"description": "This share requires a password (Header: 'ay-password') to be accessed."
},
"500": {
"description": "Internal server error. Please contact administrator."
}
}
}
},
"/shared/{id}/zip": {
"post": {
"tags": [
"Public Sharing Management"
],
"description": "Initiates the ZIP creation of a shared collection.",
"operationId": "HttpSharedCollectionsRequestZipById",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "id",
"description": "The ID of the shared collection.",
"required": true,
"type": "string"
},
{
"in": "header",
"name": "ay-password",
"description": "If shared collection has a password, this header is mandatory. Otherwise StatusCode 403 (Forbidden) is returned.",
"type": "string"
},
{
"in": "body",
"name": "body",
"description": "The request of which assets or download formats should be used..",
"schema": {
"$ref": "#/definitions/downloadZipRequest"
}
}
],
"responses": {
"201": {
"description": "Returns the requested download ZIP with created zip entity ID.",
"schema": {
"$ref": "#/definitions/downloadZipRequest"
}
},
"400": {
"description": "Not valid shared id! (Code: e1eb7b29-e501-4727-bec3-26f5099b7418)",
"schema": {
"$ref": "#/definitions/agravityErrorResponse"
}
},
"404": {
"description": "Collection on which this share is based, doesn't exist. (Code: 79dde226-ae08-4f4b-b334-de0cad89c994)<br>or Shared collection date expired! (Code: 6758d66e-0ce6-4770-a497-01a578eac12c)<br>or Shared collection not found. (Code: 87d09a21-14d6-4da4-ab69-01e6c87f108c)<br>or User null or shared collection of user not found. (Code: 5a1ea520-377d-43f1-b2c3-506443056561)<br>",
"schema": {
"$ref": "#/definitions/agravityErrorResponse"
}
},
"401": {
"description": "This share requires a password (Header: 'ay-password') to be accessed."
},
"500": {
"description": "Internal server error. Please contact administrator."
}
}
}
},
"/shared/{id}/zip/{zipId}": {
"get": {
"tags": [
"Public Sharing Management"
],
"description": "This endpoint gets the progress/status of the ZIP creation of a shared collection.",
"operationId": "HttpSharedCollectionsGetStatusZipById",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "id",
"description": "The ID of the zip request.",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "zipId",
"description": "The ID of the requested zip.",
"required": true,
"type": "string"
},
{
"in": "header",
"name": "ay-password",
"description": "If shared collection has a password, this header is mandatory. Otherwise StatusCode 401 (Unauthorized) is returned.",
"type": "string"
}
],
"responses": {
"200": {
"description": "Returns the status of the current zip request.",
"schema": {
"$ref": "#/definitions/downloadZipStatus"
}
},
"400": {
"description": "Not valid shared id! (Code: e1eb7b29-e501-4727-bec3-26f5099b7418)",
"schema": {
"$ref": "#/definitions/agravityErrorResponse"
}
},
"404": {
"description": "Collection on which this share is based, doesn't exist. (Code: 79dde226-ae08-4f4b-b334-de0cad89c994)<br>or Shared collection date expired! (Code: 6758d66e-0ce6-4770-a497-01a578eac12c)<br>or Shared collection not found. (Code: 87d09a21-14d6-4da4-ab69-01e6c87f108c)<br>or User null or shared collection of user not found. (Code: 5a1ea520-377d-43f1-b2c3-506443056561)<br>",
"schema": {
"$ref": "#/definitions/agravityErrorResponse"
}
},
"401": {
"description": "This share requires a password (Header: 'ay-password') to be accessed."
},
"500": {
"description": "Internal server error. Please contact administrator."
}
}
}
},
"/quickshares/{id}": {
"get": {
"tags": [
"Public Sharing Management"
],
"description": "Returns one single quick share (from ID)",
"operationId": "HttpQuickShareGetById",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "id",
"description": "The ID of the quick share.",
"required": true,
"type": "string"
},
{
"in": "query",
"name": "continuation_token",
"description": "Each result returns the continous token if more results are available than requested. With this token, the next page could be fetched. (URL encoded!)",
"type": "string"
},
{
"in": "query",
"name": "limit",
"description": "This number limits the page result of assets.",
"type": "integer",
"format": "int32"
},
{
"in": "query",
"name": "orderby",
"description": "How the return assets are sorted. Default is property: created_date (newest first).",
"type": "string"
}
],
"responses": {
"200": {
"description": "Returns the quick share with the given ID.",
"schema": {
"$ref": "#/definitions/quickShareFull"
}
},
"400": {
"description": "Not valid quick share id! (Code: 02141b45-97dd-4474-aefb-a7774f8b538e)",
"schema": {
"$ref": "#/definitions/agravityErrorResponse"
}
},
"404": {
"description": "Quick share date expired! (Code: 6758d66e-0ce6-4770-a497-01a578eac12c)<br>or Quick share was not found. (Code: 412f11e3-5606-4075-a319-74ff1cee6a3e)<br>or Quick share date expired! (Code: da53b1d3-83eb-4fec-9f7c-56b571f117b2)<br>",
"schema": {
"$ref": "#/definitions/agravityErrorResponse"
}
},
"500": {
"description": "Internal server error. Please contact administrator."
}
}
}
},
"/signalr/negotiate": {
"post": {
"tags": [
"Public SignalR Connection Management"
],
"description": "This endpoint delivers the connection data for a client.",
"operationId": "HttpSignalRNegotiate",
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The signalr connection info for further processing.",
"schema": {
"$ref": "#/definitions/signalRConnectionInfo"
}
},
"400": {
"description": "Could not negotiate with SignalR. (Code: 50e617b3-93e8-4b15-8072-0b3c12c26ec7)",
"schema": {
"$ref": "#/definitions/agravityErrorResponse"
}
},
"401": {
"description": "Unauthorized. API Key not provided."
}
},
"security": [
{
"function_key": []
}
]
}
},
"/staticdefinedlists": {
"get": {
"tags": [
"Public Static Defined List Management"
],
"description": "This endpoint lists all static defined lists in database.",
"operationId": "HttpStaticDefinedListsGetAll",
"produces": [
"application/json"
],
"parameters": [
{
"in": "query",
"name": "translations",
"description": "When default language should be returned and the translation dictionary is delivered. (Ignores the \"Accept-Language\" header)",
"type": "boolean"
},
{
"in": "header",
"name": "Accept-Language",
"description": "The requested language of the response. If not matching it falls back to default language.",
"type": "string"
}
],
"responses": {
"200": {
"description": "Returns all static defined lists in database.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/staticDefinedList"
}
}
},
"401": {
"description": "Unauthorized. API Key not provided."
},
"500": {
"description": "Internal server error. Please contact administrator."
}
},
"security": [
{
"function_key": []
}
]
}
},
"/staticdefinedlists/{id}": {
"get": {
"tags": [
"Public Static Defined List Management"
],
"description": "This endpoint gets a static defined list from database.",
"operationId": "HttpStaticDefinedListsGetById",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "id",
"description": "The ID of the static defined list.",
"required": true,
"type": "string"
},
{
"in": "query",
"name": "translations",
"description": "When default language should be returned and the translation dictionary is delivered. (Ignores the \"Accept-Language\" header)",
"type": "boolean"
},
{
"in": "header",
"name": "Accept-Language",
"description": "The requested language of the response. If not matching it falls back to default language.",
"type": "string"
}
],
"responses": {
"200": {
"description": "Returns a static defined list with the given id.",
"schema": {
"$ref": "#/definitions/staticDefinedList"
}
},
"404": {
"description": "The requested item could not be found."
},
"401": {
"description": "Unauthorized. API Key not provided."
},
"500": {
"description": "Internal server error. Please contact administrator."
}
},
"security": [
{
"function_key": []
}
]
},
"post": {
"tags": [
"Public Static Defined List Management"
],
"description": "This endpoint update a static defined list in database (add, delete or replace values).",
"operationId": "HttpStaticDefinedListsUpdateById",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "id",
"description": "The ID of the static defined list.",
"required": true,
"type": "string"
},
{
"in": "query",
"name": "translations",
"description": "When default language should be returned and the translation dictionary is delivered. (Ignores the \"Accept-Language\" header)",
"type": "boolean"
},
{
"in": "header",
"name": "Accept-Language",
"description": "The requested language of the response. If not matching it falls back to default language.",
"type": "string"
},
{
"in": "query",
"name": "updatemode",
"description": "The mode how the list should be updated. Available values are: add, delete and replace.",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body",
"description": "The values which should be updated.",
"required": true,
"schema": {
"$ref": "#/definitions/staticDefinedList"
}
}
],
"responses": {
"200": {
"description": "Returns the updated static defined list for values only the updated, deleted, added",
"schema": {
"$ref": "#/definitions/staticDefinedList"
}
},
"400": {
"description": "Object is not a valid static_defined_list. (Code: 0970b102-0d79-4c1c-8144-2d6576234b5a) <br>No input object given. (Code: 4d2f5034-bf4f-4f19-8f3d-56e3d88b833a)Update mode: {given-update-mode} is not a valid update mode. Allowed modes are: add, delete, replace (Code: cb08ff14-4c6b-4d88-a1d7-7b39897d78e6)Error on create static defined list in database - max retry count is reached. (Code: a524c4cf-392e-4e37-9597-12cdce014757)",
"schema": {
"$ref": "#/definitions/agravityErrorResponse"
}
},
"404": {
"description": "If the static defined list with the ID was not found."
},
"401": {
"description": "Unauthorized. API Key not provided."
},
"500": {
"description": "Internal server error. Please contact administrator."
}
},
"security": [
{
"function_key": []
}
]
}
},
"/translations/{id}": {
"get": {
"tags": [
"Public Translation Management"
],
"description": "Get all the translations of a whole entity (Asset, Collection, Collection Type, Download Format)",
"operationId": "HttpTranslationsById",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "id",
"description": "The ID of any translateable entity (Asset, Collection, Collection Type, Download Format).",
"required": true,
"type": "string"
},
{
"in": "query",
"name": "items",
"description": "If the items should be included (only for entity type Collection and Asset).",
"type": "boolean"
}
],
"responses": {
"200": {
"description": "Returns the dictionary of the dictionaries with all translations ",
"schema": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/dictionary_object"
}
}
},
"400": {
"description": "Could not get all translations from {id}! (Code: fd86fae5-1eed-4770-b519-d403b85fa1d0) <br/>Could not get entity {id} from database! (Code: eb42dc0d-78ee-4fc9-9a65-d5df472c7a03)",
"schema": {
"$ref": "#/definitions/agravityErrorResponse"
}
},
"404": {
"description": "If the entity with that ID was not found."
},
"401": {
"description": "Unauthorized. API Key not provided."
},
"500": {
"description": "Internal server error. Please contact administrator."
}
},
"security": [
{
"function_key": []
}
]
}
},
"/translations/{id}/{property}": {
"get": {
"tags": [
"Public Translation Management"
],
"description": "Get the translations of a specific field on the entity (Asset, Collection, Collection Type, Download Format)",
"operationId": "HttpTranslationsByIdFilterByProperty",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "id",
"description": "The ID of any translateable entity (Asset, Collection, Collection Type, Download Format).",
"required": true,
"type": "string"
},
{
"in": "query",
"name": "items",
"description": "If the items should be included (only for entity type Collection and Asset).",
"type": "boolean"
},
{
"in": "path",
"name": "property",
"description": "Limit to one specific property (key)",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Returns the dictionary of the dictionaries with all translations ",
"schema": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/dictionary_object"
}
}
},
"400": {
"description": "Could not get all translations from {id}! (Code: fd86fae5-1eed-4770-b519-d403b85fa1d0) <br/>Could not get entity {id} from database! (Code: eb42dc0d-78ee-4fc9-9a65-d5df472c7a03)",
"schema": {
"$ref": "#/definitions/agravityErrorResponse"
}
},
"404": {
"description": "If the entity with that ID was not found."
},
"401": {
"description": "Unauthorized. API Key not provided."
},
"500": {
"description": "Internal server error. Please contact administrator."
}
},
"security": [
{
"function_key": []
}
]
}
},
"/translations/{id}/custom/{customField}": {
"get": {
"tags": [
"Public Translation Management"
],
"description": "Get the translation of custom field on the entity (Asset, Collection)",
"operationId": "HttpTranslationsByIdFilterByCustomField",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "id",
"description": "The ID of only translateable entities with custom fields (Asset, Collection).",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "customField",
"description": "Limit the output to a specific custom field key.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Returns the dictionary of the dictionaries with all translations ",
"schema": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/dictionary_object"
}
}
},
"400": {
"description": "Could not get all translations from {id}! (Code: fd86fae5-1eed-4770-b519-d403b85fa1d0) <br/>Could not get entity {id} from database! (Code: eb42dc0d-78ee-4fc9-9a65-d5df472c7a03)",
"schema": {
"$ref": "#/definitions/agravityErrorResponse"
}
},
"404": {
"description": "If the entity with that ID was not found."
},
"401": {
"description": "Unauthorized. API Key not provided."
},
"500": {
"description": "Internal server error. Please contact administrator."
}
},
"security": [
{
"function_key": []
}
]
}
},
"/webappdata/{id}": {
"get": {
"tags": [
"Public Web App Data"
],
"description": "This lists all elements of a given collection which can be used by the web frontend. It includes structure and all assets. All coming live from database.",
"operationId": "HttpGetWebAppData",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "id",
"description": "The ID of the collection for which this web data should be prepared.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "This lists all elements which should be used by the web frontend.",
"schema": {
"$ref": "#/definitions/allWebAppData"
}
},
"400": {
"description": "Update failed. (Code: e85183ec-6183-4329-a74f-6ceb963967a3)",
"schema": {
"$ref": "#/definitions/agravityErrorResponse"
}
},
"404": {
"description": "Collection not found - Never existed, not a collection or already deleted. (Code: 1d6325bf-7c1c-41ae-ba95-e41dd037a29f)",
"schema": {
"$ref": "#/definitions/agravityErrorResponse"
}
},
"401": {
"description": "Unauthorized. API Key not provided."
},
"500": {
"description": "Internal server error. Please contact administrator."
}
},
"security": [
{
"function_key": []
}
]
}
},
"/data/collectiontype/{id}": {
"get": {
"tags": [
"Public Web App Data"
],
"description": "This returns all collections and assets from the given collection type.",
"operationId": "HttpGetDataCollectionType",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "id",
"description": "The ID of the collection type for which this web data should be prepared.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "This returns all collections and assets from the given collection type.",
"schema": {
"$ref": "#/definitions/groupAllAppData"
}
},
"400": {
"description": "Unknown request method (Code: 2e7570d3-7667-4bc9-89ea-f5d6f5aa84c0)",
"schema": {
"$ref": "#/definitions/agravityErrorResponse"
}
},
"404": {
"description": "Collection Type not found - Never existed, not a collection type or already deleted. (Code: 8f939f77-1ba9-40b7-905e-bef8ddc720a1)<br>or the web app data was never created (POST). (Code: 210910ed-68e8-4837-a58f-bfce0591cb49)",
"schema": {
"$ref": "#/definitions/agravityErrorResponse"
}
},
"401": {
"description": "Unauthorized. API Key not provided."
},
"500": {
"description": "Internal server error. Please contact administrator."
}
},
"security": [
{
"function_key": []
}
]
}
},
"/workspaces": {
"get": {
"tags": [
"Public Workspace Management"
],
"description": "This lists all available workspaces which are stored in the database and not deleted (status \"A\").",
"operationId": "HttpWorkspacesGet",
"produces": [
"application/json"
],
"parameters": [
{
"in": "query",
"name": "translations",
"description": "When default language should be returned and the translation dictionary is delivered. (Ignores the \"Accept-Language\" header)",
"type": "boolean"
},
{
"in": "header",
"name": "Accept-Language",
"description": "The requested language of the response. If not matching it falls back to default language.",
"type": "string"
}
],
"responses": {
"200": {
"description": "Returns the all workspaces as array.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/workspace"
}
}
},
"400": {
"description": "Could not create connection to CosmosDB (Code: e244cef3-2665-4757-ba34-0d4d0e71bb9d)",
"schema": {
"$ref": "#/definitions/agravityErrorResponse"
}
},
"401": {
"description": "Unauthorized. API Key not provided."
},
"500": {
"description": "Internal server error. Please contact administrator."
}
},
"security": [
{
"function_key": []
}
]
}
},
"/workspaces/{id}": {
"get": {
"tags": [
"Public Workspace Management"
],
"description": "Returns one single workspace (from ID).",
"operationId": "HttpWorkspacesGetById",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "id",
"description": "The ID of the workspace.",
"required": true,
"type": "string"
},
{
"in": "query",
"name": "translations",
"description": "When default language should be returned and the translation dictionary is delivered. (Ignores the \"Accept-Language\" header)",
"type": "boolean"
},
{
"in": "header",
"name": "Accept-Language",
"description": "The requested language of the response. If not matching it falls back to default language.",
"type": "string"
}
],
"responses": {
"200": {
"description": "Returns the workspace with the given ID.",
"schema": {
"$ref": "#/definitions/workspace"
}
},
"404": {
"description": "If the workspace with the ID was not found.",
"schema": {
"$ref": "#/definitions/agravityErrorResponse"
}
},
"401": {
"description": "Unauthorized. API Key not provided."
},
"500": {
"description": "Internal server error. Please contact administrator."
}
},
"security": [
{
"function_key": []
}
]
}
}
},
"definitions": {
"agravityErrorResponse": {
"type": "object",
"properties": {
"error_id": {
"type": "string"
},
"error_message": {
"type": "string"
},
"exception": {
"type": "string"
}
}
},
"agravityInfoResponse": {
"type": "object",
"properties": {
"info_id": {
"type": "string"
},
"info_message": {
"type": "string"
},
"info_object": {
"type": "object"
}
}
},
"agravityUser": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"entity_type": {
"type": "string"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"impersonation": {
"type": "string"
},
"apikey": {
"type": "string"
},
"online_status": {
"$ref": "#/definitions/agravityUserOnlineStatus"
},
"roles": {
"type": "array",
"items": {
"type": "string"
}
},
"groups": {
"type": "array",
"items": {
"type": "string"
}
},
"status": {
"type": "string"
},
"created_date": {
"format": "date-time",
"type": "string"
},
"created_by": {
"type": "string"
},
"modified_date": {
"format": "date-time",
"type": "string"
},
"modified_by": {
"type": "string"
},
"pk": {
"type": "string"
},
"_etag": {
"type": "string"
}
}
},
"agravityUserOnlineStatus": {
"type": "object",
"properties": {
"status": {
"type": "string"
},
"last_connection": {
"format": "date-time",
"type": "string"
}
}
},
"agravityVersion": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"company": {
"type": "string"
},
"customer": {
"type": "string"
},
"contact": {
"type": "string"
},
"updated": {
"format": "date-time",
"type": "string"
},
"client_id": {
"type": "string"
},
"tenant_id": {
"type": "string"
},
"subscription_id": {
"type": "string"
},
"base": {
"type": "string"
},
"version": {
"type": "string"
},
"enabled_features": {
"type": "array",
"items": {
"type": "string"
}
},
"region": {
"type": "string"
}
}
},
"allWebAppData": {
"type": "object",
"properties": {
"root_collection": {
"$ref": "#/definitions/collection"
},
"subcollections": {
"type": "array",
"items": {
"$ref": "#/definitions/collection"
}
},
"assets": {
"type": "array",
"items": {
"$ref": "#/definitions/asset"
}
},
"pub_assets": {
"type": "array",
"items": {
"$ref": "#/definitions/publishedAsset"
}
},
"created_date": {
"format": "date-time",
"type": "string"
}
}
},
"asset": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"entity_type": {
"type": "string"
},
"name": {
"type": "string"
},
"asset_type": {
"type": "string"
},
"duplicates": {
"type": "array",
"items": {
"type": "string"
}
},
"keywords": {
"type": "array",
"items": {
"type": "string"
}
},
"orig_blob": {
"$ref": "#/definitions/assetBlob"
},
"blobs": {
"type": "array",
"items": {
"$ref": "#/definitions/assetBlob"
}
},
"collections": {
"type": "array",
"items": {
"type": "string"
}
},
"failed_reason": {
"type": "string"
},
"quality_gate": {
"type": "array",
"items": {
"type": "string"
}
},
"region_of_origin": {
"type": "string"
},
"availability": {
"type": "string"
},
"available_from": {
"format": "date-time",
"type": "string"
},
"available_to": {
"format": "date-time",
"type": "string"
},
"checkout": {
"$ref": "#/definitions/assetCheckout"
},
"fs_synced": {
"type": "boolean"
},
"custom": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/collTypeItem"
}
},
"translations": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/dictionary_object"
}
},
"role": {
"default": "NONE",
"enum": [
"NONE",
"VIEWER",
"EDITOR"
],
"type": "string"
},
"description": {
"type": "string"
},
"add_properties": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"status": {
"type": "string"
},
"created_date": {
"format": "date-time",
"type": "string"
},
"created_by": {
"type": "string"
},
"modified_date": {
"format": "date-time",
"type": "string"
},
"modified_by": {
"type": "string"
},
"pk": {
"type": "string"
},
"_etag": {
"type": "string"
}
}
},
"assetAvailability": {
"type": "object",
"properties": {
"availability": {
"type": "string"
},
"available_from": {
"format": "date-time",
"type": "string"
},
"available_to": {
"format": "date-time",
"type": "string"
}
}
},
"assetBlob": {
"type": "object",
"properties": {
"blob_type": {
"default": "UNKNOWN",
"enum": [
"UNKNOWN",
"IMAGE",
"VIDEO",
"AUDIO",
"DOCUMENT",
"TEXT",
"OTHER"
],
"type": "string"
},
"name": {
"type": "string"
},
"container": {
"type": "string"
},
"size": {
"format": "int64",
"type": "integer"
},
"extension": {
"type": "string"
},
"content_type": {
"type": "string"
},
"md5": {
"type": "string"
},
"add_data": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"width": {
"format": "int32",
"type": "integer"
},
"height": {
"format": "int32",
"type": "integer"
},
"maxwidthheight": {
"format": "int32",
"type": "integer"
},
"quality": {
"format": "double",
"type": "number"
},
"orientation": {
"default": "PORTRAIT",
"enum": [
"PORTRAIT",
"LANDSCAPE",
"SQUARE"
],
"type": "string"
},
"colorspace": {
"type": "string"
},
"profile": {
"type": "string"
},
"transparency": {
"type": "boolean"
},
"mode": {
"type": "string"
},
"target": {
"type": "string"
},
"filter": {
"type": "string"
},
"dpi_x": {
"format": "double",
"type": "number"
},
"dpi_y": {
"format": "double",
"type": "number"
},
"perhash": {
"type": "string"
},
"dominantcolor": {
"type": "string"
},
"depth": {
"format": "int32",
"type": "integer"
},
"animated": {
"type": "boolean"
},
"duration": {
"format": "int32",
"type": "integer"
},
"videocodec": {
"type": "string"
},
"videobitrate": {
"format": "int32",
"type": "integer"
},
"fps": {
"format": "double",
"type": "number"
},
"colormode": {
"type": "string"
},
"audiocodec": {
"type": "string"
},
"audiosamplerate": {
"type": "string"
},
"audiochanneloutput": {
"type": "string"
},
"audiobitrate": {
"format": "int32",
"type": "integer"
},
"author": {
"type": "string"
},
"title": {
"type": "string"
},
"language": {
"type": "string"
},
"wordcount": {
"format": "int32",
"type": "integer"
},
"pages": {
"format": "int32",
"type": "integer"
},
"encoding_name": {
"type": "string"
},
"encoding_code": {
"type": "string"
},
"url": {
"type": "string"
},
"size_readable": {
"type": "string"
},
"downloadable": {
"type": "boolean"
},
"expires": {
"format": "date-time",
"type": "string"
},
"uploaded_date": {
"format": "date-time",
"type": "string"
},
"uploaded_by": {
"type": "string"
}
}
},
"assetBulkUpdate": {
"type": "object",
"properties": {
"collection_id": {
"type": "string"
},
"ref_asset": {
"$ref": "#/definitions/asset"
},
"asset_ids": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"assetCheckout": {
"type": "object",
"properties": {
"user_id": {
"type": "string"
},
"checkout_date": {
"format": "date-time",
"type": "string"
}
}
},
"assetIconRule": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"entity_type": {
"type": "string"
},
"type": {
"type": "string"
},
"path": {
"type": "string"
},
"color": {
"type": "string"
},
"value": {
"type": "string"
},
"icon": {
"type": "string"
},
"operator": {
"type": "string"
},
"translations": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/dictionary_object"
}
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"add_properties": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"status": {
"type": "string"
},
"created_date": {
"format": "date-time",
"type": "string"
},
"created_by": {
"type": "string"
},
"modified_date": {
"format": "date-time",
"type": "string"
},
"modified_by": {
"type": "string"
},
"pk": {
"type": "string"
},
"_etag": {
"type": "string"
}
}
},
"assetIdFormat": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"format": {
"type": "string"
}
}
},
"assetMultiPartForm": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"collectionid": {
"type": "string"
},
"file": {
"format": "binary",
"type": "string"
},
"filename": {
"type": "string"
},
"previewof": {
"type": "string"
}
}
},
"assetPageResult": {
"type": "object",
"properties": {
"page": {
"type": "array",
"items": {
"$ref": "#/definitions/asset"
}
},
"page_size": {
"format": "int32",
"type": "integer"
},
"size": {
"format": "int32",
"type": "integer"
},
"continuation_token": {
"type": "string"
},
"filter": {
"type": "array",
"items": {
"$ref": "#/definitions/whereParam"
}
}
}
},
"assetRelation": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"entity_type": {
"type": "string"
},
"assets": {
"type": "array",
"items": {
"$ref": "#/definitions/relatedAsset"
}
},
"status": {
"type": "string"
},
"created_date": {
"format": "date-time",
"type": "string"
},
"created_by": {
"type": "string"
},
"modified_date": {
"format": "date-time",
"type": "string"
},
"modified_by": {
"type": "string"
},
"pk": {
"type": "string"
},
"_etag": {
"type": "string"
}
}
},
"assetRelationType": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"entity_type": {
"type": "string"
},
"hierarchical": {
"type": "boolean"
},
"sequential": {
"type": "boolean"
},
"unique_per_asset": {
"type": "boolean"
},
"translations": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/dictionary_object"
}
},
"permissions": {
"type": "array",
"items": {
"$ref": "#/definitions/permissionEntity"
}
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"add_properties": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"status": {
"type": "string"
},
"created_date": {
"format": "date-time",
"type": "string"
},
"created_by": {
"type": "string"
},
"modified_date": {
"format": "date-time",
"type": "string"
},
"modified_by": {
"type": "string"
},
"pk": {
"type": "string"
},
"_etag": {
"type": "string"
}
}
},
"azSearchOptions": {
"type": "object",
"properties": {
"searchString": {
"type": "string"
},
"limit": {
"format": "int32",
"type": "integer"
},
"skip": {
"format": "int32",
"type": "integer"
},
"collectiontypeid": {
"type": "string"
},
"collectionid": {
"type": "string"
},
"filter": {
"type": "string"
},
"orderby": {
"type": "string"
},
"mode": {
"type": "string"
},
"broadness": {
"format": "int32",
"type": "integer"
},
"rel_id": {
"type": "string"
},
"ids": {
"type": "string"
},
"portal_id": {
"type": "string"
},
"scopefilter": {
"type": "string"
}
}
},
"collection": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"entity_type": {
"type": "string"
},
"parent": {
"type": "string"
},
"path": {
"type": "string"
},
"level": {
"format": "int32",
"type": "integer"
},
"custom": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/collTypeItem"
}
},
"translations": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/dictionary_object"
}
},
"role": {
"default": "NONE",
"enum": [
"NONE",
"VIEWER",
"EDITOR"
],
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"add_properties": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"status": {
"type": "string"
},
"created_date": {
"format": "date-time",
"type": "string"
},
"created_by": {
"type": "string"
},
"modified_date": {
"format": "date-time",
"type": "string"
},
"modified_by": {
"type": "string"
},
"pk": {
"type": "string"
},
"_etag": {
"type": "string"
}
}
},
"collectionType": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"entity_type": {
"type": "string"
},
"name": {
"type": "string"
},
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/collTypeItem"
}
},
"translations": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/dictionary_object"
}
},
"order": {
"format": "int32",
"type": "integer"
},
"permissions": {
"type": "array",
"items": {
"$ref": "#/definitions/permissionEntity"
}
},
"permissionless": {
"type": "boolean"
},
"role": {
"default": "NONE",
"enum": [
"NONE",
"VIEWER",
"EDITOR"
],
"type": "string"
},
"description": {
"type": "string"
},
"add_properties": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"status": {
"type": "string"
},
"created_date": {
"format": "date-time",
"type": "string"
},
"created_by": {
"type": "string"
},
"modified_date": {
"format": "date-time",
"type": "string"
},
"modified_by": {
"type": "string"
},
"pk": {
"type": "string"
},
"_etag": {
"type": "string"
}
}
},
"collectionUDL": {
"type": "object",
"properties": {
"children": {
"type": "array",
"items": {
"$ref": "#/definitions/entityIdName"
}
},
"name": {
"type": "string"
},
"entity_type": {
"type": "string"
},
"status": {
"type": "string"
},
"translations": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/dictionary_object"
}
},
"id": {
"type": "string"
},
"pk": {
"type": "string"
}
}
},
"collectionUDLListEntity": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"entity_type": {
"type": "string"
},
"udl_refs": {
"type": "array",
"items": {
"$ref": "#/definitions/collectionUDLReference"
}
},
"udl_entries": {
"type": "array",
"items": {
"$ref": "#/definitions/collectionUDL"
}
},
"status": {
"type": "string"
},
"created_date": {
"format": "date-time",
"type": "string"
},
"created_by": {
"type": "string"
},
"modified_date": {
"format": "date-time",
"type": "string"
},
"modified_by": {
"type": "string"
},
"pk": {
"type": "string"
},
"_etag": {
"type": "string"
}
}
},
"collectionUDLReference": {
"type": "object",
"properties": {
"parent": {
"type": "string"
},
"coll_types": {
"type": "array",
"items": {
"type": "string"
}
},
"permissions": {
"type": "array",
"items": {
"$ref": "#/definitions/permissionEntity"
}
}
}
},
"collTypeItem": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"entity_type": {
"type": "string"
},
"name": {
"type": "string"
},
"item_type": {
"type": "string"
},
"format": {
"type": "string"
},
"label": {
"type": "string"
},
"default_value": {
"type": "object"
},
"mandatory": {
"type": "boolean"
},
"searchable": {
"type": "boolean"
},
"onlyasset": {
"type": "boolean"
},
"multi": {
"type": "boolean"
},
"md5": {
"type": "string"
},
"group": {
"type": "string"
},
"order": {
"format": "int32",
"type": "integer"
},
"translations": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/dictionary_object"
}
},
"status": {
"type": "string"
},
"created_date": {
"format": "date-time",
"type": "string"
},
"created_by": {
"type": "string"
},
"modified_date": {
"format": "date-time",
"type": "string"
},
"modified_by": {
"type": "string"
},
"pk": {
"type": "string"
},
"_etag": {
"type": "string"
}
}
},
"createSftpUserResult": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"password": {
"type": "string"
}
}
},
"customClaimsProviderResponseActionAttributeCollectionSubmit": {
"type": "object",
"properties": {
"@odata.type": {
"type": "string"
}
}
},
"customClaimsProviderResponseActionTokenIssuanceStart": {
"type": "object",
"properties": {
"claims": {
"$ref": "#/definitions/customClaimsProviderResponseClaims"
},
"@odata.type": {
"type": "string"
}
}
},
"customClaimsProviderResponseClaims": {
"type": "object",
"properties": {
"userContext": {
"type": "array",
"items": {
"type": "string"
}
},
"role": {
"type": "string"
}
}
},
"customClaimsProviderResponseContentAttributeCollectionSubmit": {
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/customClaimsProviderResponseDataAttributeCollectionSubmit"
}
}
},
"customClaimsProviderResponseContentTokenIssuanceStart": {
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/customClaimsProviderResponseDataTokenIssuanceStart"
}
}
},
"customClaimsProviderResponseDataAttributeCollectionSubmit": {
"type": "object",
"properties": {
"actions": {
"type": "array",
"items": {
"$ref": "#/definitions/customClaimsProviderResponseActionAttributeCollectionSubmit"
}
},
"@odata.type": {
"type": "string"
}
}
},
"customClaimsProviderResponseDataTokenIssuanceStart": {
"type": "object",
"properties": {
"actions": {
"type": "array",
"items": {
"$ref": "#/definitions/customClaimsProviderResponseActionTokenIssuanceStart"
}
},
"@odata.type": {
"type": "string"
}
}
},
"dataResult": {
"type": "object",
"properties": {
"asset": {
"type": "array",
"items": {
"$ref": "#/definitions/asset"
}
},
"sum_asset_results": {
"format": "int32",
"type": "integer"
},
"collection": {
"type": "array",
"items": {
"$ref": "#/definitions/collection"
}
},
"sum_collection_results": {
"format": "int32",
"type": "integer"
}
}
},
"deletedEntities": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"deleted": {
"format": "date-time",
"type": "string"
},
"entity_type": {
"type": "string"
}
}
},
"dictionary_object": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"distZipResponse": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"modified_date": {
"format": "date-time",
"type": "string"
},
"size": {
"format": "int64",
"type": "integer"
}
}
},
"downloadFormat": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"entity_type": {
"type": "string"
},
"operations": {
"type": "array",
"items": {
"$ref": "#/definitions/dynamicImageOperation"
}
},
"extension": {
"type": "string"
},
"asset_type": {
"type": "string"
},
"origin": {
"type": "string"
},
"fallback_thumb": {
"type": "boolean"
},
"target_filename": {
"type": "string"
},
"translations": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/dictionary_object"
}
},
"permissions": {
"type": "array",
"items": {
"$ref": "#/definitions/permissionEntity"
}
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"add_properties": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"status": {
"type": "string"
},
"created_date": {
"format": "date-time",
"type": "string"
},
"created_by": {
"type": "string"
},
"modified_date": {
"format": "date-time",
"type": "string"
},
"modified_by": {
"type": "string"
},
"pk": {
"type": "string"
},
"_etag": {
"type": "string"
}
}
},
"downloadZipRequest": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"zip_type": {
"default": "DOWNLOAD",
"enum": [
"DOWNLOAD",
"SHARED",
"QUICKSHARE",
"PORTAL"
],
"type": "string"
},
"asset_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"allowed_formats": {
"type": "array",
"items": {
"$ref": "#/definitions/sharedAllowedFormat"
}
},
"zipname": {
"type": "string"
},
"email_to": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"valid_until": {
"format": "date-time",
"type": "string"
}
}
},
"downloadZipStatus": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"user": {
"type": "string"
},
"percent": {
"format": "double",
"type": "number"
},
"part": {
"format": "double",
"type": "number"
},
"count": {
"format": "int32",
"type": "integer"
},
"message": {
"type": "string"
},
"status": {
"type": "string"
},
"zip_type": {
"default": "DOWNLOAD",
"enum": [
"DOWNLOAD",
"SHARED",
"QUICKSHARE",
"PORTAL"
],
"type": "string"
},
"zipname": {
"type": "string"
},
"size": {
"type": "string"
},
"url": {
"type": "string"
}
}
},
"dynamicImageOperation": {
"type": "object",
"properties": {
"operation": {
"type": "string"
},
"params": {
"type": "array",
"items": {
"type": "object"
}
}
}
},
"entityId": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"pk": {
"type": "string"
}
}
},
"entityIdName": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"entity_type": {
"type": "string"
},
"status": {
"type": "string"
},
"translations": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/dictionary_object"
}
},
"id": {
"type": "string"
},
"pk": {
"type": "string"
}
}
},
"entityListResult": {
"type": "object",
"properties": {
"entities": {
"type": "array",
"items": {
"$ref": "#/definitions/entityIdName"
}
},
"notfounds": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"entityNamesRequest": {
"type": "object",
"properties": {
"names": {
"type": "array",
"items": {
"type": "string"
}
},
"filter": {
"type": "string"
}
}
},
"file": {
"type": "object"
},
"frontendAppConfig": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
},
"description": {
"type": "string"
},
"contentType": {
"type": "string"
},
"sinceApiVersion": {
"type": "string"
}
}
},
"groupAllAppData": {
"type": "object",
"properties": {
"collection_type": {
"$ref": "#/definitions/collectionType"
},
"collections": {
"type": "array",
"items": {
"$ref": "#/definitions/collection"
}
},
"assets": {
"type": "array",
"items": {
"$ref": "#/definitions/asset"
}
},
"created_date": {
"format": "date-time",
"type": "string"
},
"add_info": {
"type": "array",
"items": {
"$ref": "#/definitions/keyValuePair_object"
}
},
"dist": {
"$ref": "#/definitions/distZipResponse"
}
}
},
"keyValuePair_object": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"moveCollectionBody": {
"type": "object",
"properties": {
"from_collection_id": {
"type": "string"
},
"to_collection_id": {
"type": "string"
},
"operation": {
"type": "string"
}
}
},
"permissionEntity": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"role": {
"default": "NONE",
"enum": [
"NONE",
"VIEWER",
"EDITOR"
],
"type": "string"
}
}
},
"portal": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"entity_type": {
"type": "string"
},
"authentication": {
"$ref": "#/definitions/portalAuthentication"
},
"languages": {
"type": "string"
},
"fields": {
"type": "array",
"items": {
"$ref": "#/definitions/portalFields"
}
},
"filter": {
"type": "string"
},
"limit_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"allowed_formats": {
"type": "array",
"items": {
"$ref": "#/definitions/sharedAllowedFormat"
}
},
"asset_icon_rules": {
"type": "array",
"items": {
"$ref": "#/definitions/assetIconRule"
}
},
"allowed_origins": {
"type": "array",
"items": {
"type": "string"
}
},
"links": {
"$ref": "#/definitions/portalLinks"
},
"theme": {
"$ref": "#/definitions/portalTheme"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"add_properties": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"status": {
"type": "string"
},
"created_date": {
"format": "date-time",
"type": "string"
},
"created_by": {
"type": "string"
},
"modified_date": {
"format": "date-time",
"type": "string"
},
"modified_by": {
"type": "string"
},
"pk": {
"type": "string"
},
"_etag": {
"type": "string"
}
}
},
"portalAuthentication": {
"type": "object",
"properties": {
"method": {
"default": "UNDEFINED",
"enum": [
"UNDEFINED",
"NONE",
"PASSWORD",
"EEID",
"AUTH0"
],
"type": "string"
},
"issuer": {
"type": "string"
},
"client_id": {
"type": "string"
},
"tenant_id": {
"type": "string"
},
"password": {
"type": "string"
}
}
},
"portalConfiguration": {
"type": "object",
"properties": {
"download_formats": {
"type": "array",
"items": {
"$ref": "#/definitions/downloadFormat"
}
},
"sdls": {
"type": "array",
"items": {
"$ref": "#/definitions/staticDefinedList"
}
},
"udls": {
"type": "array",
"items": {
"$ref": "#/definitions/collectionUDL"
}
},
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/collTypeItem"
}
},
"configs": {
"type": "array",
"items": {
"$ref": "#/definitions/frontendAppConfig"
}
},
"id": {
"type": "string"
},
"entity_type": {
"type": "string"
},
"authentication": {
"$ref": "#/definitions/portalAuthentication"
},
"languages": {
"type": "string"
},
"fields": {
"type": "array",
"items": {
"$ref": "#/definitions/portalFields"
}
},
"filter": {
"type": "string"
},
"limit_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"allowed_formats": {
"type": "array",
"items": {
"$ref": "#/definitions/sharedAllowedFormat"
}
},
"asset_icon_rules": {
"type": "array",
"items": {
"$ref": "#/definitions/assetIconRule"
}
},
"allowed_origins": {
"type": "array",
"items": {
"type": "string"
}
},
"links": {
"$ref": "#/definitions/portalLinks"
},
"theme": {
"$ref": "#/definitions/portalTheme"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"add_properties": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"status": {
"type": "string"
},
"created_date": {
"format": "date-time",
"type": "string"
},
"created_by": {
"type": "string"
},
"modified_date": {
"format": "date-time",
"type": "string"
},
"modified_by": {
"type": "string"
},
"pk": {
"type": "string"
},
"_etag": {
"type": "string"
}
}
},
"portalFields": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"detail_order": {
"format": "int32",
"type": "integer"
},
"facet_order": {
"format": "int32",
"type": "integer"
},
"labels": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"user_context": {
"$ref": "#/definitions/portalUserContext"
},
"format": {
"type": "string"
}
}
},
"portalLinks": {
"type": "object",
"properties": {
"conditions": {
"type": "string"
},
"privacy": {
"type": "string"
},
"impressum": {
"type": "string"
}
}
},
"portalTheme": {
"type": "object",
"properties": {
"logo_url": {
"type": "string"
},
"topbar_color": {
"type": "string"
},
"background_url": {
"type": "string"
},
"fav_icon": {
"type": "string"
},
"icon_empty": {
"type": "string"
},
"icon_active": {
"type": "string"
},
"colors": {
"type": "object",
"additionalProperties": {
"type": "object"
}
}
}
},
"portalUserContext": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"mandatory": {
"type": "boolean"
},
"mapping": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"options": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"publishedAsset": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"target": {
"type": "string"
},
"description": {
"type": "string"
},
"usecases": {
"type": "array",
"items": {
"type": "string"
}
},
"created_date": {
"format": "date-time",
"type": "string"
},
"created_by": {
"type": "string"
},
"url": {
"type": "string"
},
"cdn": {
"type": "string"
},
"status_table_id": {
"type": "string"
},
"format": {
"type": "string"
},
"properties": {
"type": "object",
"additionalProperties": {
"type": "object"
}
}
}
},
"publishEntity": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"entity_type": {
"type": "string"
},
"published": {
"type": "array",
"items": {
"$ref": "#/definitions/publishedAsset"
}
},
"region_of_origin": {
"type": "string"
},
"status": {
"type": "string"
},
"created_date": {
"format": "date-time",
"type": "string"
},
"created_by": {
"type": "string"
},
"modified_date": {
"format": "date-time",
"type": "string"
},
"modified_by": {
"type": "string"
},
"pk": {
"type": "string"
},
"_etag": {
"type": "string"
}
}
},
"quickShareFull": {
"type": "object",
"properties": {
"page": {
"type": "array",
"items": {
"$ref": "#/definitions/sharedAsset"
}
},
"page_size": {
"format": "int32",
"type": "integer"
},
"size": {
"format": "int32",
"type": "integer"
},
"continuation_token": {
"type": "string"
},
"id": {
"type": "string"
},
"entity_type": {
"type": "string"
},
"name": {
"type": "string"
},
"assets": {
"type": "array",
"items": {
"$ref": "#/definitions/assetIdFormat"
}
},
"users": {
"type": "array",
"items": {
"$ref": "#/definitions/entityId"
}
},
"expires": {
"format": "date-time",
"type": "string"
},
"url": {
"type": "string"
},
"zip_url": {
"type": "string"
},
"status": {
"type": "string"
},
"created_date": {
"format": "date-time",
"type": "string"
},
"created_by": {
"type": "string"
},
"modified_date": {
"format": "date-time",
"type": "string"
},
"modified_by": {
"type": "string"
},
"pk": {
"type": "string"
},
"_etag": {
"type": "string"
}
}
},
"relatedAsset": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"parent": {
"type": "boolean"
}
}
},
"sasToken": {
"type": "object",
"properties": {
"token": {
"type": "string"
},
"container": {
"type": "string"
},
"blob": {
"type": "string"
},
"url": {
"type": "string"
},
"fulltoken": {
"type": "string"
},
"expires": {
"format": "date-time",
"type": "string"
}
}
},
"savedSearch": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"entity_type": {
"type": "string"
},
"searchstring": {
"type": "string"
},
"external": {
"type": "boolean"
},
"translations": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/dictionary_object"
}
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"add_properties": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"status": {
"type": "string"
},
"created_date": {
"format": "date-time",
"type": "string"
},
"created_by": {
"type": "string"
},
"modified_date": {
"format": "date-time",
"type": "string"
},
"modified_by": {
"type": "string"
},
"pk": {
"type": "string"
},
"_etag": {
"type": "string"
}
}
},
"searchableItem": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"is_key": {
"type": "boolean"
},
"filterable": {
"type": "boolean"
},
"hidden": {
"type": "boolean"
},
"searchable": {
"type": "boolean"
},
"facetable": {
"type": "boolean"
},
"sortable": {
"type": "boolean"
},
"is_collection": {
"type": "boolean"
},
"searchtype": {
"type": "string"
},
"fields": {
"type": "array",
"items": {
"$ref": "#/definitions/searchableItem"
}
}
}
},
"searchAdminDataSourceStatus": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"status": {
"type": "string"
}
}
},
"searchAdminIndexerLastRun": {
"type": "object",
"properties": {
"status": {
"type": "string"
},
"starttime": {
"format": "date-time",
"type": "string"
},
"endtime": {
"format": "date-time",
"type": "string"
},
"itemcount": {
"format": "int64",
"type": "integer"
},
"faileditemcount": {
"format": "int64",
"type": "integer"
}
}
},
"searchAdminIndexerStatus": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"status": {
"type": "string"
},
"error": {
"type": "string"
},
"lastrun": {
"$ref": "#/definitions/searchAdminIndexerLastRun"
},
"history": {
"type": "array",
"items": {
"$ref": "#/definitions/searchAdminIndexerLastRun"
}
}
}
},
"searchAdminIndexStatus": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"status": {
"type": "string"
},
"statistics": {
"$ref": "#/definitions/searchAdminStatistics"
}
}
},
"searchAdminSkillStatus": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"skills": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"searchAdminStatistics": {
"type": "object",
"properties": {
"documentcount": {
"format": "int64",
"type": "integer"
},
"storagesizebytes": {
"format": "int64",
"type": "integer"
}
}
},
"searchAdminStatus": {
"type": "object",
"properties": {
"index": {
"$ref": "#/definitions/searchAdminIndexStatus"
},
"indexer": {
"$ref": "#/definitions/searchAdminIndexerStatus"
},
"datasource": {
"$ref": "#/definitions/searchAdminDataSourceStatus"
},
"skillsets": {
"type": "array",
"items": {
"$ref": "#/definitions/searchAdminSkillStatus"
}
}
}
},
"searchFacet": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"entities": {
"type": "array",
"items": {
"$ref": "#/definitions/searchFacetEntity"
}
}
}
},
"searchFacetEntity": {
"type": "object",
"properties": {
"count": {
"format": "int64",
"type": "integer"
},
"value": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"searchResult": {
"type": "object",
"properties": {
"data_result": {
"$ref": "#/definitions/dataResult"
},
"options": {
"$ref": "#/definitions/azSearchOptions"
},
"facets": {
"type": "array",
"items": {
"$ref": "#/definitions/searchFacet"
}
},
"count": {
"format": "int64",
"type": "integer"
}
}
},
"secureUploadEntity": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"entity_type": {
"type": "string"
},
"collection_id": {
"type": "string"
},
"url": {
"type": "string"
},
"valid_until": {
"format": "date-time",
"type": "string"
},
"password": {
"type": "string"
},
"asset_tags": {
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"type": "string"
},
"sftp_connection": {
"$ref": "#/definitions/createSftpUserResult"
},
"check_name_for_version": {
"type": "boolean"
},
"status": {
"type": "string"
},
"created_date": {
"format": "date-time",
"type": "string"
},
"created_by": {
"type": "string"
},
"modified_date": {
"format": "date-time",
"type": "string"
},
"modified_by": {
"type": "string"
},
"pk": {
"type": "string"
},
"_etag": {
"type": "string"
}
}
},
"sharedAllowedFormat": {
"type": "object",
"properties": {
"asset_type": {
"type": "string"
},
"format": {
"type": "string"
}
}
},
"sharedAsset": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"created_date": {
"format": "date-time",
"type": "string"
},
"modified_date": {
"format": "date-time",
"type": "string"
},
"asset_type": {
"type": "string"
},
"orig_blob": {
"$ref": "#/definitions/assetBlob"
},
"blobs": {
"type": "array",
"items": {
"$ref": "#/definitions/assetBlob"
}
}
}
},
"sharedCollectionFull": {
"type": "object",
"properties": {
"page": {
"type": "array",
"items": {
"$ref": "#/definitions/sharedAsset"
}
},
"page_size": {
"format": "int32",
"type": "integer"
},
"size": {
"format": "int32",
"type": "integer"
},
"continuation_token": {
"type": "string"
},
"id": {
"type": "string"
},
"entity_type": {
"type": "string"
},
"collection_id": {
"type": "string"
},
"url": {
"type": "string"
},
"valid_until": {
"format": "date-time",
"type": "string"
},
"valid_for": {
"type": "string"
},
"message": {
"type": "string"
},
"global": {
"type": "boolean"
},
"allowed_formats": {
"type": "array",
"items": {
"$ref": "#/definitions/sharedAllowedFormat"
}
},
"password": {
"type": "string"
},
"status": {
"type": "string"
},
"created_date": {
"format": "date-time",
"type": "string"
},
"created_by": {
"type": "string"
},
"modified_date": {
"format": "date-time",
"type": "string"
},
"modified_by": {
"type": "string"
},
"pk": {
"type": "string"
},
"_etag": {
"type": "string"
}
}
},
"signalRConnectionInfo": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"accessToken": {
"type": "string"
}
}
},
"staticDefinedList": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"entity_type": {
"type": "string"
},
"translations": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/dictionary_object"
}
},
"values": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"add_properties": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"status": {
"type": "string"
},
"created_date": {
"format": "date-time",
"type": "string"
},
"created_by": {
"type": "string"
},
"modified_date": {
"format": "date-time",
"type": "string"
},
"modified_by": {
"type": "string"
},
"pk": {
"type": "string"
},
"_etag": {
"type": "string"
}
}
},
"versionedAsset": {
"type": "object",
"properties": {
"version_nr": {
"format": "int32",
"type": "integer"
},
"until_date": {
"format": "date-time",
"type": "string"
},
"version_info": {
"type": "string"
},
"created_date": {
"format": "date-time",
"type": "string"
},
"created_by": {
"type": "string"
},
"blob_data": {
"$ref": "#/definitions/assetBlob"
},
"blob_uploaded": {
"format": "date-time",
"type": "string"
},
"mime_type": {
"type": "string"
}
}
},
"versionEntity": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"entity_type": {
"type": "string"
},
"versions": {
"type": "array",
"items": {
"$ref": "#/definitions/versionedAsset"
}
},
"region_of_origin": {
"type": "string"
},
"status": {
"type": "string"
},
"created_date": {
"format": "date-time",
"type": "string"
},
"created_by": {
"type": "string"
},
"modified_date": {
"format": "date-time",
"type": "string"
},
"modified_by": {
"type": "string"
},
"pk": {
"type": "string"
},
"_etag": {
"type": "string"
}
}
},
"whereParam": {
"type": "object",
"properties": {
"operator": {
"default": "Equals",
"enum": [
"Equals",
"NotEquals",
"GreaterThan",
"LessThan",
"GreaterThanOrEqual",
"LessThanOrEqual",
"Contains",
"StartsWith",
"ArrayContains",
"ArrayContainsPartial",
"IsDefined",
"IsNotDefined",
"IsEmpty",
"IsNotEmpty"
],
"type": "string"
},
"field": {
"type": "string"
},
"value": {
"type": "object"
},
"notPrefix": {
"type": "boolean"
},
"valueType": {
"default": "String",
"enum": [
"String",
"Bool",
"Number"
],
"type": "string"
}
}
},
"workspace": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"entity_type": {
"type": "string"
},
"name": {
"type": "string"
},
"collection_types": {
"type": "array",
"items": {
"$ref": "#/definitions/collectionType"
}
},
"translations": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/dictionary_object"
}
},
"order": {
"format": "int32",
"type": "integer"
},
"permissions": {
"type": "array",
"items": {
"$ref": "#/definitions/permissionEntity"
}
},
"description": {
"type": "string"
},
"add_properties": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"status": {
"type": "string"
},
"created_date": {
"format": "date-time",
"type": "string"
},
"created_by": {
"type": "string"
},
"modified_date": {
"format": "date-time",
"type": "string"
},
"modified_by": {
"type": "string"
},
"pk": {
"type": "string"
},
"_etag": {
"type": "string"
}
}
}
},
"securityDefinitions": {
"function_key": {
"type": "apiKey",
"name": "x-functions-key",
"in": "header"
}
}
}
Reference in a new issue View git blame Copy permalink